AGSLocatorTask.h

Go to the documentation of this file.

/*
 COPYRIGHT 1995-2020 ESRI
 
 TRADE SECRETS: ESRI PROPRIETARY AND CONFIDENTIAL
 Unpublished material - all rights reserved under the
 Copyright Laws of the United States and applicable international
 laws, treaties, and conventions.
 
 For additional information, contact:
 Environmental Systems Research Institute, Inc.
 Attn: Contracts and Legal Services Department
 380 New York Street
 Redlands, California, 92373
 USA
 
 email: contracts@esri.com
 */

#import <ArcGIS/AGSLoadableRemoteResourceBase.h>



@class AGSLocatorInfo;
@class AGSGeocodeParameters;
@class AGSReverseGeocodeParameters;
@class AGSSuggestParameters;
@class AGSSuggestResult;
@class AGSGeocodeResult;
@class AGSPoint;

@protocol AGSCancelable;
 //Required for Globals API doc

@interface AGSLocatorTask : AGSLoadableRemoteResourceBase

#pragma mark -
#pragma mark initializers



-(instancetype)initWithURL:(NSURL*)URL;

+(instancetype)locatorTaskWithURL:(NSURL*)URL;

-(instancetype)initWithName:(NSString*)name;

+(instancetype)locatorTaskWithName:(NSString*)name;

#pragma mark -
#pragma mark properties

@property (nullable, nonatomic, strong, readonly) AGSLocatorInfo *locatorInfo;

#pragma mark -
#pragma mark methods

-(id<AGSCancelable>)geocodeWithSearchText:(NSString *)searchText
                                completion:(void(^)(NSArray<AGSGeocodeResult*> * __nullable geocodeResults, NSError * __nullable error))completion;

-(id<AGSCancelable>)geocodeWithSearchText:(NSString*)searchText
                                parameters:(AGSGeocodeParameters*)parameters
                                completion:(void(^)(NSArray<AGSGeocodeResult*> * __nullable geocodeResults, NSError * __nullable error))completion;

-(id<AGSCancelable>)geocodeWithSuggestResult:(AGSSuggestResult*)suggestResult
                                   completion:(void(^)(NSArray<AGSGeocodeResult*> * __nullable geocodeResults, NSError * __nullable error))completion;

-(id<AGSCancelable>)geocodeWithSuggestResult:(AGSSuggestResult*)suggestResult
                                   parameters:(AGSGeocodeParameters*)parameters
                                   completion:(void(^)(NSArray<AGSGeocodeResult*> * __nullable geocodeResults, NSError * __nullable error))completion;

-(id<AGSCancelable>)geocodeWithSearchValues:(NSDictionary<NSString*, NSString*> *)searchValues
                                  completion:(void(^)(NSArray<AGSGeocodeResult*> * __nullable geocodeResults, NSError * __nullable error))completion;

-(id<AGSCancelable>)geocodeWithSearchValues:(NSDictionary<NSString*, NSString*> *)searchValues
                                  parameters:(AGSGeocodeParameters*)parameters
                                  completion:(void(^)(NSArray<AGSGeocodeResult*> * __nullable geocodeResults, NSError * __nullable error))completion;

-(id<AGSCancelable>)reverseGeocodeWithLocation:(AGSPoint*)location
                                     completion:(void(^)(NSArray<AGSGeocodeResult*> * __nullable geocodeResults, NSError * __nullable error))completion;

-(id<AGSCancelable>)reverseGeocodeWithLocation:(AGSPoint*)location
                                     parameters:(AGSReverseGeocodeParameters*)parameters
                                     completion:(void(^)(NSArray<AGSGeocodeResult*> * __nullable geocodeResults, NSError * __nullable error))completion;

-(id<AGSCancelable>)suggestWithSearchText:(NSString*)searchText
                                completion:(void(^)(NSArray<AGSSuggestResult*> * __nullable suggestResults, NSError * __nullable error))completion;

-(id<AGSCancelable>)suggestWithSearchText:(NSString*)searchText
                                parameters:(AGSSuggestParameters*)parameters
                                completion:(void(^)(NSArray<AGSSuggestResult*> * __nullable suggestResults, NSError * __nullable error))completion;

@end