AGSOfflineMapTask.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/AGSLoadableBase.h>

@class AGSGeometry;
@class AGSMap;
@class AGSPortalItem;
@class AGSGenerateOfflineMapJob;
@class AGSGenerateOfflineMapParameters;
@class AGSOfflineMapCapabilities;
@class AGSDownloadPreplannedOfflineMapJob;
@class AGSPreplannedMapArea;
@class AGSDownloadPreplannedOfflineMapParameters;
@class AGSGenerateOfflineMapParameterOverrides;

@protocol AGSCancelable;
 //Required for Globals API doc

@interface AGSOfflineMapTask : AGSLoadableBase



#pragma mark -
#pragma mark initializers

-(instancetype)initWithOnlineMap:(AGSMap *)onlineMap;

-(instancetype)initWithPortalItem:(AGSPortalItem *)portalItem;

+(instancetype)offlineMapTaskWithOnlineMap:(AGSMap *)onlineMap;

+(instancetype)offlineMapTaskWithPortalItem:(AGSPortalItem *)portalItem;

#pragma mark -
#pragma mark properties

@property (nullable, nonatomic, strong, readonly) AGSMap *onlineMap;

@property (nullable, nonatomic, strong, readonly) AGSPortalItem *portalItem;

#pragma mark -
#pragma mark methods

-(AGSGenerateOfflineMapJob *)generateOfflineMapJobWithParameters:(AGSGenerateOfflineMapParameters *)parameters
                                               downloadDirectory:(NSURL *)downloadDirectory;

-(AGSGenerateOfflineMapJob *)generateOfflineMapJobWithParameters:(AGSGenerateOfflineMapParameters *)parameters
                                              parameterOverrides:(AGSGenerateOfflineMapParameterOverrides *)parameterOverrides
                                               downloadDirectory:(NSURL *)downloadDirectory;

-(id<AGSCancelable>)defaultDownloadPreplannedOfflineMapParametersWithArea:(AGSPreplannedMapArea *)preplannedMapArea
                                                               completion:(void(^)(AGSDownloadPreplannedOfflineMapParameters * __nullable params, NSError * __nullable error))completion;

-(id<AGSCancelable>)defaultGenerateOfflineMapParametersWithAreaOfInterest:(AGSGeometry *)areaOfInterest
                                                               completion:(void(^)(AGSGenerateOfflineMapParameters * __nullable params, NSError * __nullable error))completion;

-(id<AGSCancelable>)defaultGenerateOfflineMapParametersWithAreaOfInterest:(AGSGeometry *)areaOfInterest
                                                                 minScale:(double)minScale
                                                                 maxScale:(double)maxScale
                                                               completion:(void(^)(AGSGenerateOfflineMapParameters * __nullable params, NSError * __nullable error))completion;

-(id<AGSCancelable>)generateOfflineMapParameterOverridesWithParameters:(AGSGenerateOfflineMapParameters*)parameters
                                                            completion:(void(^)(AGSGenerateOfflineMapParameterOverrides * __nullable parameterOverrides, NSError * __nullable error))completion;

-(id<AGSCancelable>)getOfflineMapCapabilitiesWithParameters:(AGSGenerateOfflineMapParameters *)parameters
                                                 completion:(void(^)(AGSOfflineMapCapabilities * __nullable params, NSError * __nullable error))completion;

-(AGSDownloadPreplannedOfflineMapJob*)downloadPreplannedOfflineMapJobWithArea:(AGSPreplannedMapArea *)preplannedMapArea
                                                            downloadDirectory:(NSURL *)downloadDirectory;

-(AGSDownloadPreplannedOfflineMapJob*)downloadPreplannedOfflineMapJobWithArea:(AGSPreplannedMapArea *)preplannedMapArea
                                                            downloadDirectory:(NSURL *)downloadDirectory
                                                               excludeBasemap:(BOOL)excludeBasemap;

-(AGSDownloadPreplannedOfflineMapJob*)downloadPreplannedOfflineMapJobWithParameters:(AGSDownloadPreplannedOfflineMapParameters *)parameters
                                                                  downloadDirectory:(NSURL *)downloadDirectory;

-(id<AGSCancelable>)getPreplannedMapAreasWithCompletion:(void(^)(NSArray<AGSPreplannedMapArea*> * __nullable preplannedMapAreas, NSError * __nullable error))completion;

@end