ArcGIS Runtime SDK for iOS: AGSGeodatabaseSyncTask.h Source File
ArcGIS Runtime SDK for iOS  100.11
AGSGeodatabaseSyncTask.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/AGSLoadableRemoteResourceBase.h>
27 #import <ArcGIS/AGSGeodatabaseTaskTypes.h>
28 #import <ArcGIS/AGSAPIKeyResource.h>
29 
30 
31 
37 @class AGSGeodatabase;
38 @class AGSSyncLayerResult;
39 @class AGSGeometry;
40 
41 @protocol AGSCancelable;
42  //Required for Globals API doc
44 
60 
61 #pragma mark -
62 #pragma mark initializers
63 
64 
65 
70 -(instancetype)initWithURL:(NSURL *)URL;
71 
77 +(instancetype)geodatabaseSyncTaskWithURL:(NSURL *)URL;
78 
79 #pragma mark -
80 #pragma mark properties
81 
85 @property (nullable, nonatomic, strong, readonly) AGSArcGISFeatureServiceInfo *featureServiceInfo;
86 
87 #pragma mark -
88 #pragma mark methods
89 
101 -(id<AGSCancelable>)defaultGenerateGeodatabaseParametersWithExtent:(AGSGeometry*)extent
102  completion:(nullable void(^)(AGSGenerateGeodatabaseParameters * __nullable params, NSError * __nullable error))completion;
103 
116 -(id<AGSCancelable>)defaultSyncGeodatabaseParametersWithGeodatabase:(AGSGeodatabase*)geodatabase
117  completion:(nullable void(^)(AGSSyncGeodatabaseParameters * __nullable params, NSError * __nullable error))completion;
118 
137 -(id<AGSCancelable>)defaultSyncGeodatabaseParametersWithGeodatabase:(AGSGeodatabase*)geodatabase
138  syncDirection:(AGSSyncDirection)syncDirection
139  completion:(nullable void(^)(AGSSyncGeodatabaseParameters * __nullable params, NSError * __nullable error))completion;
140 
173 + (id<AGSCancelable>)exportDeltaWithGeodatabase:(AGSGeodatabase *)geodatabase
174  outputFileURL:(NSURL *)outputFileURL
175  completion:(void(^)(BOOL result, NSError * __nullable error))completion;
176 
202 -(id<AGSCancelable>)importDeltaWithGeodatabase:(AGSGeodatabase*)geodatabase inputPath:(NSString*)inputPath completion:(void(^)(NSArray<AGSSyncLayerResult*> * __nullable result, NSError * __nullable error))completion;
203 
225 +(id<AGSCancelable>)importDeltaWithGeodatabase:(AGSGeodatabase*)geodatabase deltaPath:(NSURL *)deltaPath completion:(void(^)(NSArray<AGSSyncLayerResult*> * __nullable result, NSError * __nullable error))completion;
226 
227 
243 -(id<AGSCancelable>)registerSyncEnabledGeodatabase:(AGSGeodatabase*)geodatabase completion:(nullable void(^)(NSError * __nullable error))completion;
244 
253 -(AGSGenerateGeodatabaseJob*)generateJobWithParameters:(AGSGenerateGeodatabaseParameters *)parameters
254  downloadFileURL:(NSURL *)downloadFileURL;
255 
277 -(AGSSyncGeodatabaseJob*)syncJobWithParameters:(AGSSyncGeodatabaseParameters *)parameters
278  geodatabase:(AGSGeodatabase *)geodatabase;
279 
303 -(AGSSyncGeodatabaseJob*)syncJobWithSyncDirection:(AGSSyncDirection)syncDirection
304  rollbackOnFailure:(BOOL)rollbackOnFailure
305  geodatabase:(AGSGeodatabase *)geodatabase;
306 
320 -(id<AGSCancelable>)unregisterGeodatabase:(AGSGeodatabase *)geodatabase completion:(nullable void(^)(NSError * __nullable error))completion;
321 
322 
337 -(id<AGSCancelable>)unregisterGeodatabaseWithSyncID:(NSUUID*)syncID completion:(nullable void(^)(NSError * __nullable error))completion;
338 
339 @end
340 
341 
AGSSyncDirection
Definition: AGSGeodatabaseTaskTypes.h:45
information about an ArcGIS Feature service
Definition: AGSArcGISFeatureServiceInfo.h:46
A job to generate a geodatabase from an ArcGIS Feature service.
Definition: AGSGenerateGeodatabaseJob.h:43
Parameters to generate a sync-enabled geodatabase.
Definition: AGSGenerateGeodatabaseParameters.h:56
A geodatabase on disk.
Definition: AGSGeodatabase.h:45
A task to download and synchronize a sync-enabled geodatabase.
Definition: AGSGeodatabaseSyncTask.h:59
AGSArcGISFeatureServiceInfo * featureServiceInfo
Definition: AGSGeodatabaseSyncTask.h:85
Base class for all classes that represent geometric shapes.
Definition: AGSGeometry.h:121
Definition: AGSLoadableRemoteResourceBase.h:35
A job to synchronize changes between a geodatabase and an ArcGIS Feature service.
Definition: AGSSyncGeodatabaseJob.h:44
Parameters to synchronize data of a sync-enabled geodatabase.
Definition: AGSSyncGeodatabaseParameters.h:44
Result of a sync operation by AGSSyncGeodatabaseJob.
Definition: AGSSyncLayerResult.h:41
An interface for getting and setting the API key of an object.
Definition: AGSAPIKeyResource.h:36
A protocol exposed by operations that allow cancellation.
Definition: AGSCancelable.h:38