ArcGIS Runtime SDK for iOS: AGSOfflineMapTask.h Source File
ArcGIS Runtime SDK for iOS  100.15
AGSOfflineMapTask.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/AGSLoadableBase.h>
27 #import <ArcGIS/AGSCancelable.h>
28 
29 @class AGSGeometry;
30 @class AGSMap;
31 @class AGSPortalItem;
39  //Required for Globals API doc
41 
69 
70 
71 
72 #pragma mark -
73 #pragma mark initializers
74 
79 -(instancetype)initWithOnlineMap:(AGSMap *)onlineMap;
80 
86 -(instancetype)initWithPortalItem:(AGSPortalItem *)portalItem;
87 
93 +(instancetype)offlineMapTaskWithOnlineMap:(AGSMap *)onlineMap;
94 
101 +(instancetype)offlineMapTaskWithPortalItem:(AGSPortalItem *)portalItem;
102 
103 #pragma mark -
104 #pragma mark properties
105 
109 @property (nullable, nonatomic, strong, readonly) AGSMap *onlineMap;
110 
115 @property (nullable, nonatomic, strong, readonly) AGSPortalItem *portalItem;
116 
117 #pragma mark -
118 #pragma mark methods
119 
129 -(AGSGenerateOfflineMapJob *)generateOfflineMapJobWithParameters:(AGSGenerateOfflineMapParameters *)parameters
130  downloadDirectory:(NSURL *)downloadDirectory;
131 
157 -(AGSGenerateOfflineMapJob *)generateOfflineMapJobWithParameters:(AGSGenerateOfflineMapParameters *)parameters
158  parameterOverrides:(AGSGenerateOfflineMapParameterOverrides *)parameterOverrides
159  downloadDirectory:(NSURL *)downloadDirectory;
160 
169 -(id<AGSCancelable>)defaultDownloadPreplannedOfflineMapParametersWithArea:(AGSPreplannedMapArea *)preplannedMapArea
170  completion:(void(^)(AGSDownloadPreplannedOfflineMapParameters * __nullable params, NSError * __nullable error))completion;
171 
188 -(id<AGSCancelable>)defaultGenerateOfflineMapParametersWithAreaOfInterest:(AGSGeometry *)areaOfInterest
189  completion:(void(^)(AGSGenerateOfflineMapParameters * __nullable params, NSError * __nullable error))completion;
190 
203 -(id<AGSCancelable>)defaultGenerateOfflineMapParametersWithAreaOfInterest:(AGSGeometry *)areaOfInterest
204  minScale:(double)minScale
205  maxScale:(double)maxScale
206  completion:(void(^)(AGSGenerateOfflineMapParameters * __nullable params, NSError * __nullable error))completion;
207 
220 -(id<AGSCancelable>)generateOfflineMapParameterOverridesWithParameters:(AGSGenerateOfflineMapParameters*)parameters
221  completion:(void(^)(AGSGenerateOfflineMapParameterOverrides * __nullable parameterOverrides, NSError * __nullable error))completion;
222 
229 -(id<AGSCancelable>)getOfflineMapCapabilitiesWithParameters:(AGSGenerateOfflineMapParameters *)parameters
230  completion:(void(^)(AGSOfflineMapCapabilities * __nullable params, NSError * __nullable error))completion;
231 
242 -(AGSDownloadPreplannedOfflineMapJob*)downloadPreplannedOfflineMapJobWithParameters:(AGSDownloadPreplannedOfflineMapParameters *)parameters
243  downloadDirectory:(NSURL *)downloadDirectory;
244 
252 -(id<AGSCancelable>)getPreplannedMapAreasWithCompletion:(void(^)(NSArray<AGSPreplannedMapArea*> * __nullable preplannedMapAreas, NSError * __nullable error))completion;
253 
254 @end
255 
257 
273 - (AGSDownloadPreplannedOfflineMapJob *)downloadPreplannedOfflineMapJobWithArea:(AGSPreplannedMapArea *)preplannedMapArea
274  downloadDirectory:(NSURL *)downloadDirectory ;
275 
295 - (AGSDownloadPreplannedOfflineMapJob *)downloadPreplannedOfflineMapJobWithArea:(AGSPreplannedMapArea *)preplannedMapArea
296  downloadDirectory:(NSURL *)downloadDirectory
297  excludeBasemap:(BOOL)excludeBasemap ;
298 
299 @end
300 
301 
Definition: AGSOfflineMapTask.h:256
A job to download an offline map from an online map.
Definition: AGSDownloadPreplannedOfflineMapJob.h:49
Parameters used with AGSOfflineMapTask to take a preplanned map area offline.
Definition: AGSDownloadPreplannedOfflineMapParameters.h:51
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:61
Offline capabilities of a map.
Definition: AGSOfflineMapCapabilities.h:41
A task to take a map offline.
Definition: AGSOfflineMapTask.h:69
AGSPortalItem * portalItem
Definition: AGSOfflineMapTask.h:115
AGSMap * onlineMap
Definition: AGSOfflineMapTask.h:109
Object representing a unit of content in an ArcGIS portal.
Definition: AGSPortalItem.h:93
Represents an individual offline map area.
Definition: AGSPreplannedMapArea.h:69
A protocol exposed by operations that allow cancellation.
Definition: AGSCancelable.h:38