The metadata for an ArcGIS feature service. More...
Header: | #include <ArcGISFeatureServiceInfo.h> |
Since: | Esri::ArcGISRuntime 100.0 |
Public Functions
ArcGISFeatureServiceInfo() | |
ArcGISFeatureServiceInfo(const Esri::ArcGISRuntime::ArcGISFeatureServiceInfo &other) | |
ArcGISFeatureServiceInfo(Esri::ArcGISRuntime::ArcGISFeatureServiceInfo &&other) | |
~ArcGISFeatureServiceInfo() | |
QString | attribution() const |
bool | canUseServiceGeodatabaseApplyEdits() const |
QString | description() const |
Esri::ArcGISRuntime::ServiceDocumentInfo | documentInfo() const |
Esri::ArcGISRuntime::EditorTrackingInfo | editorTrackingInfo() const |
Esri::ArcGISRuntime::FeatureServiceCapabilities | featureServiceCapabilities() const |
Esri::ArcGISRuntime::Envelope | fullExtent() const |
bool | hasStaticData() const |
bool | hasVersionedData() const |
Esri::ArcGISRuntime::Envelope | initialExtent() const |
bool | isAllowGeometryUpdates() const |
bool | isAllowTrueCurvesUpdates() const |
bool | isEmpty() const |
bool | isOnlyAllowTrueCurveUpdatesByTrueCurveClients() const |
bool | isSupportsDisconnectedEditing() const |
bool | isSupportsTrueCurve() const |
bool | isSyncEnabled() const |
bool | isZDefaultsEnabled() const |
QList<Esri::ArcGISRuntime::IdInfo> | layerInfos() const |
qint64 | maxRecordCount() const |
QString | serviceDescription() const |
Esri::ArcGISRuntime::SpatialReference | spatialReference() const |
Esri::ArcGISRuntime::SyncCapabilities | syncCapabilities() const |
QList<Esri::ArcGISRuntime::IdInfo> | tableInfos() const |
Esri::ArcGISRuntime::Unit | unit() const |
QUrl | url() const |
QString | version() const |
double | zDefault() const |
Esri::ArcGISRuntime::ArcGISFeatureServiceInfo & | operator=(const Esri::ArcGISRuntime::ArcGISFeatureServiceInfo &other) |
Esri::ArcGISRuntime::ArcGISFeatureServiceInfo & | operator=(Esri::ArcGISRuntime::ArcGISFeatureServiceInfo &&other) |
Detailed Description
An ArcGIS feature service is a data service that provides access to spatial features stored in layers and non-spatial features stored in tables. ArcGISFeatureServiceInfo provides basic information about the feature service, including the feature layers and tables that it contains, the service description, supported spatial reference, sync capabilities, editor tracking information, and so on.
You can obtain the ArcGISFeatureServiceInfo from a loaded GeodatabaseSyncTask or from a loaded ServiceGeodatabase.
Member Function Documentation
ArcGISFeatureServiceInfo::ArcGISFeatureServiceInfo ()
Default constructor.
ArcGISFeatureServiceInfo::ArcGISFeatureServiceInfo (const Esri::ArcGISRuntime::ArcGISFeatureServiceInfo &other)
Copy constructor from other ArcGISFeatureServiceInfo.
ArcGISFeatureServiceInfo::ArcGISFeatureServiceInfo (Esri::ArcGISRuntime::ArcGISFeatureServiceInfo &&other)
Move constructor from other ArcGISFeatureServiceInfo.
ArcGISFeatureServiceInfo::~ArcGISFeatureServiceInfo ()
Destructor.
QString ArcGISFeatureServiceInfo::attribution() const
Gets the attribution information of the service.
[since Esri::ArcGISRuntime 200.3]
bool ArcGISFeatureServiceInfo::canUseServiceGeodatabaseApplyEdits () const
Returns true
if you can use ServiceGeodatabase::applyEditsAsync to commit changes back to the service, false
otherwise.
This value is true
if the support for global IDs in all tables in the geodatabase is enabled, or support for global IDs in all tables in the geodatabase is disabled, false
otherwise.
ServiceGeodatabase::applyEditsAsync applies edits to all affected tables as a single transaction. This is the recommended approach for applying edits. However, if the service has been setup with mixed support for global IDs, then you must apply the edits individually to each affected table using ServiceFeatureTable::applyEditsAsync
If ServiceGeodatabase::applyEditsAsync is used when this property is set to false
, it can fail with ErrorType::GeodatabaseGlobalIdSupportMismatch.
This function was introduced in Esri::ArcGISRuntime 200.3.
QString ArcGISFeatureServiceInfo::description() const
Gets the description of the service.
Esri::ArcGISRuntime::ServiceDocumentInfo ArcGISFeatureServiceInfo::documentInfo () const
Gets information about the backing map document used to create the service.
Esri::ArcGISRuntime::EditorTrackingInfo ArcGISFeatureServiceInfo::editorTrackingInfo () const
Returns the feature service's editor tracking settings.
This information is present if editor tracking is enabled on this service. For more information, see Editor tracking for feature services.
Esri::ArcGISRuntime::FeatureServiceCapabilities ArcGISFeatureServiceInfo::featureServiceCapabilities () const
Gets the operations that are allowed by the service.
Operations include Query, Create, Delete, Update, Editing, and Sync.
Esri::ArcGISRuntime::Envelope ArcGISFeatureServiceInfo::fullExtent () const
Gets the full extent of geographic data available in the service.
bool ArcGISFeatureServiceInfo::hasStaticData () const
Returns true
if the service contains static data.
bool ArcGISFeatureServiceInfo::hasVersionedData () const
Returns true
if the service is backed by versioned data.
Esri::ArcGISRuntime::Envelope ArcGISFeatureServiceInfo::initialExtent () const
Gets the default extent of geographic data available in the service.
bool ArcGISFeatureServiceInfo::isAllowGeometryUpdates () const
Returns true
if the layer allows geometries of features to be updated.
You should check this property before allowing the ability to update a feature's geometry in your app.
[since Esri::ArcGISRuntime 100.12]
bool ArcGISFeatureServiceInfo::isAllowTrueCurvesUpdates () const
Returns true
if the service allows curve geometries to be updated, false
otherwise.
This property can only be true
if isSupportsTrueCurve is true
.
If this property is true
and isOnlyAllowTrueCurveUpdatesByTrueCurveClients is false
, features with curve geometries can be updated by any client. This includes cases where the client provides a densified geometry to update the curve geometry.
By default, this API is not a true curve-capable client. Use ArcGISRuntimeEnvironment::serviceCurveGeometryMode to change this behavior.
This function was introduced in Esri::ArcGISRuntime 100.12.
See also isSupportsTrueCurve, isAllowTrueCurvesUpdates, and isOnlyAllowTrueCurveUpdatesByTrueCurveClients.
bool ArcGISFeatureServiceInfo::isEmpty () const
Gets whether this ArcGISFeatureServiceInfo is empty.
A default constructed ArcGISFeatureServiceInfo is empty.
Returns true
if empty.
[since Esri::ArcGISRuntime 100.12]
bool ArcGISFeatureServiceInfo::isOnlyAllowTrueCurveUpdatesByTrueCurveClients () const
Returns true
if the service only allows curve geometries to be updated by client code that identifies itself as a true
curve-enabled client, indicating that client editing workflows account for curve segments correctly, false
otherwise.
This property can only be true
if isAllowTrueCurvesUpdates is true
.
By default, this API is not a true curve-enabled client. Use ArcGISRuntimeEnvironment::serviceCurveGeometryMode to change this behavior.
This function was introduced in Esri::ArcGISRuntime 100.12.
See also isSupportsTrueCurve and isAllowTrueCurvesUpdates.
bool ArcGISFeatureServiceInfo::isSupportsDisconnectedEditing () const
Returns true
if the service supports disconnected editing, false
otherwise.
[since Esri::ArcGISRuntime 100.12]
bool ArcGISFeatureServiceInfo::isSupportsTrueCurve () const
Returns true
if the service supports curve segments in feature geometries, false
otherwise.
Some services support storing feature geometries with curve segments. By default, these services return densified versions of the feature geometries instead. Use ArcGISRuntimeEnvironment::serviceCurveGeometryMode to change this behavior.
This function was introduced in Esri::ArcGISRuntime 100.12.
See also isAllowTrueCurvesUpdates and isOnlyAllowTrueCurveUpdatesByTrueCurveClients.
bool ArcGISFeatureServiceInfo::isSyncEnabled () const
Returns true
if the service has sync enabled, false
otherwise.
bool ArcGISFeatureServiceInfo::isZDefaultsEnabled () const
Returns true
if the service defaults z values, false
otherwise.
QList<Esri::ArcGISRuntime::IdInfo > ArcGISFeatureServiceInfo::layerInfos () const
Returns the service's layers.
The IdInfo provides basic layer metadata. It can be cast to a FeatureServiceLayerIdInfo for more detailed metadata.
qint64 ArcGISFeatureServiceInfo::maxRecordCount () const
Gets the maximum number of features that will be returned by the service for any query operation.
Applications should handle re-querying the omitted results when this limit is reached.
QString ArcGISFeatureServiceInfo::serviceDescription () const
Gets the user friendly description about the service.
Esri::ArcGISRuntime::SpatialReference ArcGISFeatureServiceInfo::spatialReference () const
Gets the spatial reference of geographic data available in the service.
Esri::ArcGISRuntime::SyncCapabilities ArcGISFeatureServiceInfo::syncCapabilities () const
Gets the information about sync related capabilities of the service.
This is null if the service does not support sync.
See also isSyncEnabled.
QList<Esri::ArcGISRuntime::IdInfo > ArcGISFeatureServiceInfo::tableInfos () const
Gets information about tables in the service.
Esri::ArcGISRuntime::Unit ArcGISFeatureServiceInfo::unit() const
Gets the unit used by the service.
QUrl ArcGISFeatureServiceInfo::url() const
Gets the service URL.
QString ArcGISFeatureServiceInfo::version() const
Gets the version of the service.
double ArcGISFeatureServiceInfo::zDefault () const
Gets the default z-value of the service.
Esri::ArcGISRuntime::ArcGISFeatureServiceInfo &ArcGISFeatureServiceInfo::operator=(const Esri::ArcGISRuntime::ArcGISFeatureServiceInfo &other)
Assignment operator from other ArcGISFeatureServiceInfo.
Esri::ArcGISRuntime::ArcGISFeatureServiceInfo &ArcGISFeatureServiceInfo::operator=(Esri::ArcGISRuntime::ArcGISFeatureServiceInfo &&other)
Move operator from other ArcGISFeatureServiceInfo.