ArcGIS Runtime SDK for iOS: AGSGeodatabaseSyncTask.h Source File
ArcGIS Runtime SDK for iOS  100.15
AGSGeodatabaseSyncTask.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/AGSLoadableRemoteResourceBase.h>
27 #import <ArcGIS/AGSGeodatabaseTaskTypes.h>
28 #import <ArcGIS/AGSAPIKeyResource.h>
29 #import <ArcGIS/AGSCancelable.h>
30 
31 
32 
38 @class AGSGeodatabase;
39 @class AGSSyncLayerResult;
40 @class AGSGeometry;
41  //Required for Globals API doc
43 
59 
60 #pragma mark -
61 #pragma mark initializers
62 
63 
64 
69 -(instancetype)initWithURL:(NSURL *)URL;
70 
76 +(instancetype)geodatabaseSyncTaskWithURL:(NSURL *)URL;
77 
78 #pragma mark -
79 #pragma mark properties
80 
84 @property (nullable, nonatomic, strong, readonly) AGSArcGISFeatureServiceInfo *featureServiceInfo;
85 
86 #pragma mark -
87 #pragma mark methods
88 
100 -(id<AGSCancelable>)defaultGenerateGeodatabaseParametersWithExtent:(AGSGeometry*)extent
101  completion:(nullable void(^)(AGSGenerateGeodatabaseParameters * __nullable params, NSError * __nullable error))completion;
102 
115 -(id<AGSCancelable>)defaultSyncGeodatabaseParametersWithGeodatabase:(AGSGeodatabase*)geodatabase
116  completion:(nullable void(^)(AGSSyncGeodatabaseParameters * __nullable params, NSError * __nullable error))completion;
117 
136 -(id<AGSCancelable>)defaultSyncGeodatabaseParametersWithGeodatabase:(AGSGeodatabase*)geodatabase
137  syncDirection:(AGSSyncDirection)syncDirection
138  completion:(nullable void(^)(AGSSyncGeodatabaseParameters * __nullable params, NSError * __nullable error))completion;
139 
172 + (id<AGSCancelable>)exportDeltaWithGeodatabase:(AGSGeodatabase *)geodatabase
173  outputFileURL:(NSURL *)outputFileURL
174  completion:(void(^)(BOOL result, NSError * __nullable error))completion;
175 
197 +(id<AGSCancelable>)importDeltaWithGeodatabase:(AGSGeodatabase*)geodatabase deltaPath:(NSURL *)deltaPath completion:(void(^)(NSArray<AGSSyncLayerResult*> * __nullable result, NSError * __nullable error))completion;
198 
199 
215 -(id<AGSCancelable>)registerSyncEnabledGeodatabase:(AGSGeodatabase*)geodatabase completion:(nullable void(^)(NSError * __nullable error))completion;
216 
225 -(AGSGenerateGeodatabaseJob*)generateJobWithParameters:(AGSGenerateGeodatabaseParameters *)parameters
226  downloadFileURL:(NSURL *)downloadFileURL;
227 
249 -(AGSSyncGeodatabaseJob*)syncJobWithParameters:(AGSSyncGeodatabaseParameters *)parameters
250  geodatabase:(AGSGeodatabase *)geodatabase;
251 
275 -(AGSSyncGeodatabaseJob*)syncJobWithSyncDirection:(AGSSyncDirection)syncDirection
276  rollbackOnFailure:(BOOL)rollbackOnFailure
277  geodatabase:(AGSGeodatabase *)geodatabase;
278 
292 -(id<AGSCancelable>)unregisterGeodatabase:(AGSGeodatabase *)geodatabase completion:(nullable void(^)(NSError * __nullable error))completion;
293 
294 
309 -(id<AGSCancelable>)unregisterGeodatabaseWithSyncID:(NSUUID*)syncID completion:(nullable void(^)(NSError * __nullable error))completion;
310 
311 @end
312 
314 
350 - (id<AGSCancelable>)importDeltaWithGeodatabase:(AGSGeodatabase *)geodatabase
351  inputPath:(NSString *)inputPath
352  completion:(void(^)(NSArray<AGSSyncLayerResult *> * _Nullable result, NSError * _Nullable error))completion ;
353 
354 @end
355 
356 
AGSSyncDirection
Definition: AGSGeodatabaseTaskTypes.h:45
Definition: AGSGeodatabaseSyncTask.h:313
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:49
A task to download and synchronize a sync-enabled geodatabase.
Definition: AGSGeodatabaseSyncTask.h:58
AGSArcGISFeatureServiceInfo * featureServiceInfo
Definition: AGSGeodatabaseSyncTask.h:84
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:47
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