ArcGIS Runtime SDK for iOS: AGSDownloadPreplannedOfflineMapJob.h Source File
ArcGIS Runtime SDK for iOS  100.11
AGSDownloadPreplannedOfflineMapJob.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/AGSJob.h>
27 
29 @class AGSOfflineMapTask;
30 @class AGSMap;
33  //Required for Globals API doc
35 
47 
48 
49 
50 #pragma mark -
51 #pragma mark initializers
52 
53 
54 
55 #pragma mark -
56 #pragma mark properties
57 
61 @property (nullable, nonatomic, strong, readonly) NSURL *downloadDirectory;
62 
66 @property (nonatomic, assign, readonly) BOOL excludeBasemap;
67 
71 @property (nonatomic, strong, readonly) AGSMap *onlineMap;
72 
76 @property (nullable, nonatomic, strong, readonly) AGSDownloadPreplannedOfflineMapParameters *parameters;
77 
81 @property (nonatomic, strong, readonly) AGSPreplannedMapArea *preplannedMapArea;
82 
86 @property (nullable, nonatomic, strong, readonly) AGSDownloadPreplannedOfflineMapResult *result;
87 
88 #pragma mark -
89 #pragma mark methods
90 
96 -(void)startWithStatusHandler:(nullable void(^)(AGSJobStatus status))statusHandler
97  completion:(void(^)(AGSDownloadPreplannedOfflineMapResult * __nullable result, NSError * __nullable error))completion;
98 
99 
100 
101 @end
AGSJobStatus
Definition: AGSJob.h:52
A job to download a map's preplanned area.
Definition: AGSDownloadPreplannedOfflineMapJob.h:47
AGSDownloadPreplannedOfflineMapResult * result
Definition: AGSDownloadPreplannedOfflineMapJob.h:86
AGSMap * onlineMap
Definition: AGSDownloadPreplannedOfflineMapJob.h:71
AGSPreplannedMapArea * preplannedMapArea
Definition: AGSDownloadPreplannedOfflineMapJob.h:81
AGSDownloadPreplannedOfflineMapParameters * parameters
Definition: AGSDownloadPreplannedOfflineMapJob.h:76
NSURL * downloadDirectory
Definition: AGSDownloadPreplannedOfflineMapJob.h:61
BOOL excludeBasemap
Definition: AGSDownloadPreplannedOfflineMapJob.h:66
Parameters used with AGSOfflineMapTask to take a preplanned map area offline.
Definition: AGSDownloadPreplannedOfflineMapParameters.h:50
Results of taking a map offline using preplanned map areas.
Definition: AGSDownloadPreplannedOfflineMapResult.h:43
A long running job on a remote server.
Definition: AGSJob.h:72
AGSJobStatus status
Definition: AGSJob.h:105
NSError * error
Definition: AGSJob.h:85
A map containing 2D geographic content.
Definition: AGSMap.h:68
A task to take a map offline.
Definition: AGSOfflineMapTask.h:66
Represents an individual preplanned map area.
Definition: AGSPreplannedMapArea.h:66