ArcGIS Runtime SDK for iOS: AGSServiceGeodatabase.h Source File
ArcGIS Runtime SDK for iOS  100.12
AGSServiceGeodatabase.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  //Required for Globals API doc
26 
27 #import <Foundation/Foundation.h>
28 #import <ArcGIS/AGSLoadableBase.h>
29 #import <ArcGIS/AGSRemoteResource.h>
30 
31 
32 
52 typedef NS_ENUM(NSInteger, AGSFeatureServiceSessionType) {
55 };
56 
59 @class AGSPortalItem;
63 
64 @protocol AGSCancelable;
65 
75 
76 #pragma mark -
77 #pragma mark initializers
78 
79 
80 
87 - (instancetype)initWithURL:(NSURL *)URL;
88 
96 + (instancetype)serviceGeodatabaseWithURL:(NSURL *)URL;
97 
108 - (instancetype)initWithURL:(NSURL *)URL
109  sessionType:(AGSFeatureServiceSessionType)sessionType;
110 
122 + (instancetype)serviceGeodatabaseWithURL:(NSURL *)URL
123  sessionType:(AGSFeatureServiceSessionType)sessionType;
124 
132 - (instancetype)initWithURL:(NSURL *)URL
133  versionName:(NSString *)versionName;
134 
143 + (instancetype)serviceGeodatabaseWithURL:(NSURL *)URL
144  versionName:(NSString *)versionName;
145 
157 - (instancetype)initWithURL:(NSURL *)URL
158  versionName:(NSString *)versionName
159  sessionType:(AGSFeatureServiceSessionType)sessionType;
160 
173 + (instancetype)serviceGeodatabaseWithURL:(NSURL *)URL
174  versionName:(NSString *)versionName
175  sessionType:(AGSFeatureServiceSessionType)sessionType;
176 
185 - (instancetype)initWithPortalItem:(AGSPortalItem *)portalItem;
186 
195 + (instancetype)serviceGeodatabaseWithPortalItem:(AGSPortalItem *)portalItem;
196 
209 - (instancetype)initWithPortalItem:(AGSPortalItem *)portalItem
210  sessionType:(AGSFeatureServiceSessionType)sessionType;
211 
224 + (instancetype)serviceGeodatabaseWithPortalItem:(AGSPortalItem *)portalItem
225  sessionType:(AGSFeatureServiceSessionType)sessionType;
226 
236 - (instancetype)initWithPortalItem:(AGSPortalItem *)portalItem
237  versionName:(NSString *)versionName;
238 
248 + (instancetype)serviceGeodatabaseWithPortalItem:(AGSPortalItem *)portalItem
249  versionName:(NSString *)versionName;
250 
263 - (instancetype)initWithPortalItem:(AGSPortalItem *)portalItem
264  versionName:(NSString *)versionName
265  sessionType:(AGSFeatureServiceSessionType)sessionType;
266 
279 + (instancetype)serviceGeodatabaseWithPortalItem:(AGSPortalItem *)portalItem
280  versionName:(NSString *)versionName
281  sessionType:(AGSFeatureServiceSessionType)sessionType;
282 
283 #pragma mark -
284 #pragma mark properties
285 
289 @property (nonatomic, copy, readonly) NSArray<AGSServiceFeatureTable *> *connectedTables;
290 
294 @property (nonatomic, copy, readonly) NSString *defaultVersionName;
295 
299 @property (nullable, nonatomic, strong, readonly) AGSArcGISFeatureServiceInfo *serviceInfo;
300 
317 @property (nonatomic, assign, readwrite) AGSFeatureServiceSessionType sessionType;
318 
322 @property (nonatomic, assign, readonly) BOOL supportsBranchVersioning;
323 
330 @property (nonatomic, copy, readonly) NSString *versionName;
331 
336 @property (nullable, nonatomic, strong, readonly) AGSPortalItem *portalItem;
337 
338 #pragma mark -
339 #pragma mark methods
340 
350 - (id<AGSCancelable>)applyEditsWithCompletion:(void(^)(NSArray<AGSFeatureTableEditResult *> * __nullable result, NSError * __nullable error))completion;
351 
368 - (id<AGSCancelable>)closeWithCompletion:(void(^)(NSError * __nullable error))completion;
369 
384 - (id<AGSCancelable>)createVersionWithParameters:(AGSServiceVersionParameters *)parameters
385  completion:(void(^)(AGSServiceVersionInfo * __nullable result, NSError * __nullable error))completion;
386 
396 - (id<AGSCancelable>)fetchVersionsWithCompletion:(void(^)(NSArray<AGSServiceVersionInfo *> * __nullable result, NSError * __nullable error))completion;
397 
402 - (BOOL)hasLocalEdits;
403 
419 - (id<AGSCancelable>)switchVersionWithName:(NSString *)versionName
420  completion:(void(^)(NSError * __nullable error))completion;
421 
431 - (nullable AGSServiceFeatureTable *)tableWithLayerID:(NSInteger)layerID;
432 
439 - (id<AGSCancelable>)undoLocalEditsWithCompletion:(void(^)(NSError * __nullable error))completion;
440 
441 @end
442 
443 
AGSFeatureServiceSessionType
Definition: AGSServiceGeodatabase.h:52
@ AGSFeatureServiceSessionTypePersistent
Definition: AGSServiceGeodatabase.h:54
@ AGSFeatureServiceSessionTypeTransient
Definition: AGSServiceGeodatabase.h:53
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:92
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:74
NSArray< AGSServiceFeatureTable * > * connectedTables
Definition: AGSServiceGeodatabase.h:289
AGSArcGISFeatureServiceInfo * serviceInfo
Definition: AGSServiceGeodatabase.h:299
AGSPortalItem * portalItem
Definition: AGSServiceGeodatabase.h:336
NSString * versionName
Definition: AGSServiceGeodatabase.h:330
AGSFeatureServiceSessionType sessionType
Definition: AGSServiceGeodatabase.h:317
BOOL supportsBranchVersioning
Definition: AGSServiceGeodatabase.h:322
NSString * defaultVersionName
Definition: AGSServiceGeodatabase.h:294
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