ArcGIS Runtime SDK for iOS: AGSServiceGeodatabase.h Source File
ArcGIS Runtime SDK for iOS  100.15
AGSServiceGeodatabase.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  //Required for Globals API doc
26 
27 #import <Foundation/Foundation.h>
28 #import <ArcGIS/AGSLoadableBase.h>
29 #import <ArcGIS/AGSRemoteResource.h>
30 #import <ArcGIS/AGSCancelable.h>
31 
32 
33 
53 typedef NS_ENUM(NSInteger, AGSFeatureServiceSessionType) {
56 };
57 
60 @class AGSPortalItem;
64 
74 
75 #pragma mark -
76 #pragma mark initializers
77 
78 
79 
86 - (instancetype)initWithURL:(NSURL *)URL;
87 
95 + (instancetype)serviceGeodatabaseWithURL:(NSURL *)URL;
96 
107 - (instancetype)initWithURL:(NSURL *)URL
108  sessionType:(AGSFeatureServiceSessionType)sessionType;
109 
121 + (instancetype)serviceGeodatabaseWithURL:(NSURL *)URL
122  sessionType:(AGSFeatureServiceSessionType)sessionType;
123 
131 - (instancetype)initWithURL:(NSURL *)URL
132  versionName:(NSString *)versionName;
133 
142 + (instancetype)serviceGeodatabaseWithURL:(NSURL *)URL
143  versionName:(NSString *)versionName;
144 
156 - (instancetype)initWithURL:(NSURL *)URL
157  versionName:(NSString *)versionName
158  sessionType:(AGSFeatureServiceSessionType)sessionType;
159 
172 + (instancetype)serviceGeodatabaseWithURL:(NSURL *)URL
173  versionName:(NSString *)versionName
174  sessionType:(AGSFeatureServiceSessionType)sessionType;
175 
184 - (instancetype)initWithPortalItem:(AGSPortalItem *)portalItem;
185 
194 + (instancetype)serviceGeodatabaseWithPortalItem:(AGSPortalItem *)portalItem;
195 
208 - (instancetype)initWithPortalItem:(AGSPortalItem *)portalItem
209  sessionType:(AGSFeatureServiceSessionType)sessionType;
210 
223 + (instancetype)serviceGeodatabaseWithPortalItem:(AGSPortalItem *)portalItem
224  sessionType:(AGSFeatureServiceSessionType)sessionType;
225 
235 - (instancetype)initWithPortalItem:(AGSPortalItem *)portalItem
236  versionName:(NSString *)versionName;
237 
247 + (instancetype)serviceGeodatabaseWithPortalItem:(AGSPortalItem *)portalItem
248  versionName:(NSString *)versionName;
249 
262 - (instancetype)initWithPortalItem:(AGSPortalItem *)portalItem
263  versionName:(NSString *)versionName
264  sessionType:(AGSFeatureServiceSessionType)sessionType;
265 
278 + (instancetype)serviceGeodatabaseWithPortalItem:(AGSPortalItem *)portalItem
279  versionName:(NSString *)versionName
280  sessionType:(AGSFeatureServiceSessionType)sessionType;
281 
282 #pragma mark -
283 #pragma mark properties
284 
288 @property (nonatomic, copy, readonly) NSArray<AGSServiceFeatureTable *> *connectedTables;
289 
293 @property (nonatomic, copy, readonly) NSString *defaultVersionName;
294 
298 @property (nullable, nonatomic, strong, readonly) AGSArcGISFeatureServiceInfo *serviceInfo;
299 
316 @property (nonatomic, assign, readwrite) AGSFeatureServiceSessionType sessionType;
317 
321 @property (nonatomic, assign, readonly) BOOL supportsBranchVersioning;
322 
329 @property (nonatomic, copy, readonly) NSString *versionName;
330 
335 @property (nullable, nonatomic, strong, readonly) AGSPortalItem *portalItem;
336 
337 #pragma mark -
338 #pragma mark methods
339 
349 - (id<AGSCancelable>)applyEditsWithCompletion:(void(^)(NSArray<AGSFeatureTableEditResult *> * __nullable result, NSError * __nullable error))completion;
350 
367 - (id<AGSCancelable>)closeWithCompletion:(void(^)(NSError * __nullable error))completion;
368 
383 - (id<AGSCancelable>)createVersionWithParameters:(AGSServiceVersionParameters *)parameters
384  completion:(void(^)(AGSServiceVersionInfo * __nullable result, NSError * __nullable error))completion;
385 
395 - (id<AGSCancelable>)fetchVersionsWithCompletion:(void(^)(NSArray<AGSServiceVersionInfo *> * __nullable result, NSError * __nullable error))completion;
396 
401 - (BOOL)hasLocalEdits;
402 
418 - (id<AGSCancelable>)switchVersionWithName:(NSString *)versionName
419  completion:(void(^)(NSError * __nullable error))completion;
420 
430 - (nullable AGSServiceFeatureTable *)tableWithLayerID:(NSInteger)layerID;
431 
438 - (id<AGSCancelable>)undoLocalEditsWithCompletion:(void(^)(NSError * __nullable error))completion;
439 
440 @end
441 
442 
AGSFeatureServiceSessionType
Definition: AGSServiceGeodatabase.h:53
@ AGSFeatureServiceSessionTypePersistent
Definition: AGSServiceGeodatabase.h:55
@ AGSFeatureServiceSessionTypeTransient
Definition: AGSServiceGeodatabase.h:54
information about an ArcGIS Feature service
Definition: AGSArcGISFeatureServiceInfo.h:46
The edit results of a specific AGSFeatureTable.
Definition: AGSFeatureTableEditResult.h:41
A base class for loadables.
Definition: AGSLoadableBase.h:45
Object representing a unit of content in an ArcGIS portal.
Definition: AGSPortalItem.h:93
A dataset from an individual layer or table in an ArcGIS map or feature service.
Definition: AGSServiceFeatureTable.h:117
A container for a collection of AGSServiceFeatureTable connected to a feature service.
Definition: AGSServiceGeodatabase.h:73
NSArray< AGSServiceFeatureTable * > * connectedTables
Definition: AGSServiceGeodatabase.h:288
AGSArcGISFeatureServiceInfo * serviceInfo
Definition: AGSServiceGeodatabase.h:298
AGSPortalItem * portalItem
Definition: AGSServiceGeodatabase.h:335
NSString * versionName
Definition: AGSServiceGeodatabase.h:329
AGSFeatureServiceSessionType sessionType
Definition: AGSServiceGeodatabase.h:316
BOOL supportsBranchVersioning
Definition: AGSServiceGeodatabase.h:321
NSString * defaultVersionName
Definition: AGSServiceGeodatabase.h:293
An object that represents version metadata for a version in a branch-versioned feature service.
Definition: AGSServiceVersionInfo.h:52
The parameters used to create a new version in a branch-versioned feature service.
Definition: AGSServiceVersionParameters.h:39
A protocol exposed by operations that allow cancellation.
Definition: AGSCancelable.h:38
A protocol adopted by classes that access remote network resources that have the potential to be secu...
Definition: AGSRemoteResource.h:40