ArcGIS Runtime SDK for iOS: AGSOfflineMapTask.h Source File
ArcGIS Runtime SDK for iOS  100.11
AGSOfflineMapTask.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/AGSLoadableBase.h>
27 
28 @class AGSGeometry;
29 @class AGSMap;
30 @class AGSPortalItem;
38 
39 @protocol AGSCancelable;
40  //Required for Globals API doc
42 
66 
67 
68 
69 #pragma mark -
70 #pragma mark initializers
71 
76 -(instancetype)initWithOnlineMap:(AGSMap *)onlineMap;
77 
83 -(instancetype)initWithPortalItem:(AGSPortalItem *)portalItem;
84 
90 +(instancetype)offlineMapTaskWithOnlineMap:(AGSMap *)onlineMap;
91 
98 +(instancetype)offlineMapTaskWithPortalItem:(AGSPortalItem *)portalItem;
99 
100 #pragma mark -
101 #pragma mark properties
102 
106 @property (nullable, nonatomic, strong, readonly) AGSMap *onlineMap;
107 
112 @property (nullable, nonatomic, strong, readonly) AGSPortalItem *portalItem;
113 
114 #pragma mark -
115 #pragma mark methods
116 
126 -(AGSGenerateOfflineMapJob *)generateOfflineMapJobWithParameters:(AGSGenerateOfflineMapParameters *)parameters
127  downloadDirectory:(NSURL *)downloadDirectory;
128 
154 -(AGSGenerateOfflineMapJob *)generateOfflineMapJobWithParameters:(AGSGenerateOfflineMapParameters *)parameters
155  parameterOverrides:(AGSGenerateOfflineMapParameterOverrides *)parameterOverrides
156  downloadDirectory:(NSURL *)downloadDirectory;
157 
166 -(id<AGSCancelable>)defaultDownloadPreplannedOfflineMapParametersWithArea:(AGSPreplannedMapArea *)preplannedMapArea
167  completion:(void(^)(AGSDownloadPreplannedOfflineMapParameters * __nullable params, NSError * __nullable error))completion;
168 
185 -(id<AGSCancelable>)defaultGenerateOfflineMapParametersWithAreaOfInterest:(AGSGeometry *)areaOfInterest
186  completion:(void(^)(AGSGenerateOfflineMapParameters * __nullable params, NSError * __nullable error))completion;
187 
200 -(id<AGSCancelable>)defaultGenerateOfflineMapParametersWithAreaOfInterest:(AGSGeometry *)areaOfInterest
201  minScale:(double)minScale
202  maxScale:(double)maxScale
203  completion:(void(^)(AGSGenerateOfflineMapParameters * __nullable params, NSError * __nullable error))completion;
204 
217 -(id<AGSCancelable>)generateOfflineMapParameterOverridesWithParameters:(AGSGenerateOfflineMapParameters*)parameters
218  completion:(void(^)(AGSGenerateOfflineMapParameterOverrides * __nullable parameterOverrides, NSError * __nullable error))completion;
219 
226 -(id<AGSCancelable>)getOfflineMapCapabilitiesWithParameters:(AGSGenerateOfflineMapParameters *)parameters
227  completion:(void(^)(AGSOfflineMapCapabilities * __nullable params, NSError * __nullable error))completion;
228 
239 -(AGSDownloadPreplannedOfflineMapJob*)downloadPreplannedOfflineMapJobWithParameters:(AGSDownloadPreplannedOfflineMapParameters *)parameters
240  downloadDirectory:(NSURL *)downloadDirectory;
241 
249 -(id<AGSCancelable>)getPreplannedMapAreasWithCompletion:(void(^)(NSArray<AGSPreplannedMapArea*> * __nullable preplannedMapAreas, NSError * __nullable error))completion;
250 
251 @end
252 
254 
270 - (AGSDownloadPreplannedOfflineMapJob *)downloadPreplannedOfflineMapJobWithArea:(AGSPreplannedMapArea *)preplannedMapArea
271  downloadDirectory:(NSURL *)downloadDirectory ;
272 
292 - (AGSDownloadPreplannedOfflineMapJob *)downloadPreplannedOfflineMapJobWithArea:(AGSPreplannedMapArea *)preplannedMapArea
293  downloadDirectory:(NSURL *)downloadDirectory
294  excludeBasemap:(BOOL)excludeBasemap ;
295 
296 @end
297 
298 
Definition: AGSOfflineMapTask.h:253
A job to download a map's preplanned area.
Definition: AGSDownloadPreplannedOfflineMapJob.h:47
Parameters used with AGSOfflineMapTask to take a preplanned map area offline.
Definition: AGSDownloadPreplannedOfflineMapParameters.h:50
A job to take a map offline.
Definition: AGSGenerateOfflineMapJob.h:46
Gives access to the individual parameters objects that will generate the various geodatabase,...
Definition: AGSGenerateOfflineMapParameterOverrides.h:44
Parameters used with a AGSOfflineMapTask object to take a map offline.
Definition: AGSGenerateOfflineMapParameters.h:73
Base class for all classes that represent geometric shapes.
Definition: AGSGeometry.h:121
A base class for loadables.
Definition: AGSLoadableBase.h:45
A map containing 2D geographic content.
Definition: AGSMap.h:68
Offline capabilities of a map.
Definition: AGSOfflineMapCapabilities.h:41
A task to take a map offline.
Definition: AGSOfflineMapTask.h:66
AGSPortalItem * portalItem
Definition: AGSOfflineMapTask.h:112
AGSMap * onlineMap
Definition: AGSOfflineMapTask.h:106
Object representing a unit of content in an ArcGIS portal.
Definition: AGSPortalItem.h:93
Represents an individual preplanned map area.
Definition: AGSPreplannedMapArea.h:66
A protocol exposed by operations that allow cancellation.
Definition: AGSCancelable.h:38