ServiceFeatureTable Class

Member Function Documentation

[explicit] ServiceFeatureTable::ServiceFeatureTable(const QUrl &url, QObject *parent = nullptr)

Creates a new service feature table object from a given URL.

• url - The URL of an individual layer or table in an ArcGIS map or feature service.
• parent - The optional parent QObject.

[since Esri::ArcGISRuntime 100.1] ServiceFeatureTable::ServiceFeatureTable(Esri::ArcGISRuntime::ServiceFeatureTable *table, const Esri::ArcGISRuntime::RelationshipInfo &relationshipInfo, QObject *parent = nullptr)

Creates a new service feature table object from the specified table and relationship information.

• table - The table from which to create a new table.
• relationshipInfo - The relationship information specifying which table to create.
• parent - The optional parent QObject.

This function was introduced in Esri::ArcGISRuntime 100.1.

ServiceFeatureTable::ServiceFeatureTable(const QUrl &url, Esri::ArcGISRuntime::Credential *credential, QObject *parent = nullptr)

Constructs a service feature table from a specified url, credential and an optional parent.

ServiceFeatureTable::ServiceFeatureTable(Esri::ArcGISRuntime::Item *item, qint64 layerId, QObject *parent = nullptr)

Creates a new service feature table object from a feature service portal item.

• item - An ArcGIS feature service PortalItem.
• layerId - The layer id of an individual layer in the ArcGIS feature service represented by the Item.
• parent - The optional parent QObject.

See also item.

[explicit, since Esri::ArcGISRuntime 100.14] ServiceFeatureTable::ServiceFeatureTable(Esri::ArcGISRuntime::Item *item, QObject *parent = nullptr)

Creates a new service feature table object from a feature service or feature layer portal item.

• item - A feature service or feature layer PortalItem.
• parent - The optional parent QObject.

If the portal item is a feature service, then the ServiceFeatureTable is created from the first layer on the service. If the portal item is a feature layer, then the ServiceFeatureTable is created from the feature layer.

This function was introduced in Esri::ArcGISRuntime 100.14.

See also item.

[override virtual] ServiceFeatureTable::~ServiceFeatureTable()

Destructor.

[override virtual, since Esri::ArcGISRuntime 100.10] QString ServiceFeatureTable::apiKey() const

Reimplements: ApiKeyResource::apiKey() const.

Returns the API key allows your app to access ArcGIS location services and private portal items.

An API key is a unique long-lived access token that is used to authenticate and monitor requests to ArcGIS location services and private portal items. You can create and manage an API key using your portal when you sign in with an ArcGIS Location Platform account or an ArcGIS Online account with administrator access or a custom role that has the `Generate API keys` privilege. To learn how to create and manage API keys, go to the Create an API Key tutorial. You must ensure that your API key has the correct privileges to access secure resources.

Note: An API key created with a referrer is not supported. If you need service requests to include the referrer, use the SDK's functionality to intercept the request and add an HTTP referer header.

In addition to setting an ArcGISRuntimeEnvironment::apiKey at a global level for your application, you can set it on any class that implements ApiKeyResource. This overrides the ArcGISRuntimeEnvironment::apiKey and enables more granular usage telemetry and management of ArcGIS location resources used by your app.

Classes that expose an API key property by implementing ApiKeyResource include:

• Basemap
• ArcGISSceneLayer
• ArcGISTiledLayer
• ArcGISVectorTiledLayer
• ServiceFeatureTable
• ExportVectorTilesTask
• LocatorTask
• GeodatabaseSyncTask
• ClosestFacilityTask
• RouteTask
• ServiceAreaTask
• ExportTileCacheTask

For more information, see API key authentication and Types of authentication.

This function was introduced in Esri::ArcGISRuntime 100.10.

See also setApiKey().

[since Esri::ArcGISRuntime 200.2] QFuture<QList<Esri::ArcGISRuntime::FeatureEditResult *>> ServiceFeatureTable::applyEditsAsync(QObject *parent = nullptr)

Uploads any changes to the local table to the feature service.

• parent - An optional parent.

applyEditsAsync is meant to be used for single table workflows or tables without geodatabase behavior (see below). If an edit on this table can cause an edit to another table due to geodatabase behavior, it is highly recommended to use ServiceGeodatabase::applyEditsAsync instead to prevent data inconsistency, so that dependent edits are all applied or none are (if an error occurs).

For example, when tables have a composite relationship, applying the delete of a destination feature in a composite relationship deletion will only delete the destination feature on the server, therefore causing inconsistency in the data.

Areas which have geodatabase behavior:

• Composite relationships
• Annotation feature layers
• Utility network association deletion semantics
• Attribute rules

This method returns a QFuture for the asynchronous operation. Use future.then() to continue processing when the operation completes. Use future.onFailed() to handle exceptions of type ErrorException.

See Working with QFuture for further details.

This function was introduced in Esri::ArcGISRuntime 200.2.

See also FeatureServiceSessionType.

double ServiceFeatureTable::bufferFactor() const

Returns the factor used to calculate a buffered extent around the current visible area when requesting features from a service.

New features are requested from the service if the visible area of the MapView exceeds the buffered extent. A change in the visible area can result from any user interaction with the MapView, such as a pan or zoom action. The buffer factor is applied when the FeatureRequestMode is in either FeatureRequestMode::OnInteractionCache or FeatureRequestMode::OnInteractionNoCache.

The default value is 2 (twice the current extent). The maximum value is 10. If it is set to 0 or 1, the buffered extent will equal the visible map area.

See also setBufferFactor().

void ServiceFeatureTable::clearCache(bool keepLocalEdits = true)

Clears all the data in the table, including any temporary edits.

keepLocalEdits If true, then edited rows in the table won't be cleared.

[override virtual] Esri::ArcGISRuntime::Credential *ServiceFeatureTable::credential() const

Reimplements: RemoteResource::credential() const.

Returns the security credential used to access the feature service.

Only applicable if the service is secured.

See also setCredential().

[since Esri::ArcGISRuntime 100.2] QString ServiceFeatureTable::definitionExpression() const

Returns an expression (SQL where clause) to filter features queried in this table.

The definition expression string uses the SQL-92 where clause syntax (https://en.wikipedia.org/wiki/SQL-92). Be sure to escape special characters in the expression string as required for your platform. The DATE keyword expects the date format yyyy-mm-dd and the TIMESTAMP keyword expects the time stamp format yyyy-mm-dd hh:mm:ss. For more information, see the ArcGIS Blog article Querying Feature Services Date-Time Queries.

This function was introduced in Esri::ArcGISRuntime 100.2.

See also setDefinitionExpression().

Esri::ArcGISRuntime::FeatureRequestMode ServiceFeatureTable::featureRequestMode() const

Defines when features and non-spatial records are requested from the feature service.

The default value is FeatureRequestMode::OnInteractionCache.

You cannot change the feature request mode after the table is successfully loaded.

See also setFeatureRequestMode().

QString ServiceFeatureTable::geodatabaseVersion() const

Returns the service geodatabase version name.

This property is populated if the ServiceFeatureTable is provided by a layer or a table in a web map or if the ServiceFeatureTable is created using ServiceGeodatabase::table(qint64).

The default geodatabase version has the string value "sde.DEFAULT".

See also setGeodatabaseVersion().

[since Esri::ArcGISRuntime 100.14] Esri::ArcGISRuntime::Item *ServiceFeatureTable::item() const

Returns the Item that defines the service feature table.

This function was introduced in Esri::ArcGISRuntime 100.14.

See also ServiceFeatureTable(Esri::ArcGISRuntime::Item*, qint64, QObject*).

[since Esri::ArcGISRuntime 200.2] QFuture<void> ServiceFeatureTable::loadOrRefreshFeaturesAsync(const QList<Esri::ArcGISRuntime::Feature *> &features)

Loads all attributes and geometries for features that have not been loaded and fetches attributes and geometries for previously loaded features.

• features - The features to be loaded or refreshed.

Features returned from queryFeaturesAsync(const Esri::ArcGISRuntime::QueryParameters&, Esri::ArcGISRuntime::QueryFeatureFields, QObject*) or queryRelatedFeaturesAsync(Esri::ArcGISRuntime::ArcGISFeature*, const Esri::ArcGISRuntime::RelatedQueryParameters&, Esri::ArcGISRuntime::QueryFeatureFields, QObject*) may be in the minimally loaded state (minimum attributes required for rendering and no m-values). To load all attributes, pass a mutable array of the features to this method.

Any feature requested, but not returned, by the server will have its object id cleared (set to an invalid negative value) to indicate it is no longer associated with the service feature table.

After calling this method, any non-applied edits on the table will be lost.

This method will not refresh feature attachments. Use AttachmentListModel::fetchAttachmentsAsync to retrieve attachments.

All features loaded or refreshed by this method will have m-values if defined by the service. Note that an m-value may be NaN. This method returns a QFuture for the asynchronous operation. Use future.then() to continue processing when the operation completes. Use future.onFailed() to handle exceptions of type ErrorException.

See Working with QFuture for further details.

This function was introduced in Esri::ArcGISRuntime 200.2.

[since Esri::ArcGISRuntime 200.2] QFuture<Esri::ArcGISRuntime::FeatureQueryResult *> ServiceFeatureTable::populateFromServiceAsync(const Esri::ArcGISRuntime::QueryParameters &parameters, bool clearCache, const QStringList &outFields, QObject *parent = nullptr)

Queries the feature service and places the resulting features in the local table, which is cached for the duration of the session. The ServiceFeatureTable must have its featureRequestMode set to FeatureRequestMode::ManualCache.

• parameters - Options for controlling the operation.
• clearCache - true, if you want to clear the local cache before populating the local table. false, if you want to append the features to the local table.
• outFields - A QStringList. Each string is the name of a field to be used when populating the cache. If the array contains the single element "*", then all fields will be used. If the ObjectID field string name is not provided as part of the QStringList, no features will be returned for this method.
• parent - An optional parent.

This method is useful for non-geographic data. It's also helpful when you want to avoid accessing the service for a feature whose geometry is in the current extent of the map or scene.

Specifying an empty QStringList for outfields results in the minimum set of fields being used to populate the local table. This is the same set of fields described for FeatureRequestMode::OnInteractionCache or FeatureRequestMode::OnInteractionNoCache. This method returns a QFuture for the asynchronous operation. Use future.then() to continue processing when the operation completes. Use future.onFailed() to handle exceptions of type ErrorException.

See Working with QFuture for further details.

This function was introduced in Esri::ArcGISRuntime 200.2.

See also FeatureServiceSessionType.

[since Esri::ArcGISRuntime 200.2] QFuture<Esri::ArcGISRuntime::FeatureQueryResult *> ServiceFeatureTable::queryFeaturesAsync(const Esri::ArcGISRuntime::QueryParameters &parameters, Esri::ArcGISRuntime::QueryFeatureFields queryFeatureFields, QObject *parent = nullptr)

Queries the features from this table's cache and/or from the feature service used to create this table.

• parameters - Options for controlling the operation.
• queryFeatureFields - Options for controlling what fields are in the features of the query result.
• parent - An optional parent.

If the request mode of the table is FeatureRequestMode::ManualCache, then the query is always performed on the local table.

If the mode is FeatureRequestMode::OnInteractionCache, then the query is performed on the local cache, provided that the geometries of the features are within an extent that has been cached; otherwise, the query is performed on the server.

If the mode is FeatureRequestMode::OnInteractionNoCache, the query is always performed on the server.

QueryFeatureFields controls which fields will be included with the returned features. The options are:

• If the service feature table FeatureRequestMode is onInteractionCache or onInteractionNoCache, the table will initially contains features with a minimum set of attribute required for rendering. To access all the feature's attributes you must load the features QueryFeatureFields::LoadAll automatically loads the returned features into the local table and makes all attributes available.
• If the service feature table FeatureRequestMode is manualCache, the table will contain the fields that you specified when calling populateFromServiceAsync(const Esri::ArcGISRuntime::QueryParameters&, bool, const QStringList&, QObject*)

Note that you can query any attribute defined by the feature service's table. If the attribute is not in the set of attributes in your local table, the query will be performed on the server.

This method returns a QFuture for the asynchronous operation. Use future.then() to continue processing when the operation completes. Use future.onFailed() to handle exceptions of type ErrorException.

See Working with QFuture for further details.

This function was introduced in Esri::ArcGISRuntime 200.2.

See also FeatureServiceSessionType.

[since Esri::ArcGISRuntime 200.2] QFuture<QList<Esri::ArcGISRuntime::RelatedFeatureQueryResult *>> ServiceFeatureTable::queryRelatedFeaturesAsync(Esri::ArcGISRuntime::ArcGISFeature *feature, const Esri::ArcGISRuntime::RelatedQueryParameters &parameters, Esri::ArcGISRuntime::QueryFeatureFields queryFeatureFields, QObject *parent = nullptr)

Queries for related features in this service feature table using the provided parameters and query feature fields. See queryFeaturesAsync(const Esri::ArcGISRuntime::QueryParameters&, Esri::ArcGISRuntime::QueryFeatureFields, QObject*) for more details.

• feature - The feature for which to query related features.
• parameters - The related query parameters.
• queryFeatureFields - Enumeration indicating which fields to return from the query.
• parent - An optional parent.

This method returns a QFuture for the asynchronous operation. Use future.then() to continue processing when the operation completes. Use future.onFailed() to handle exceptions of type ErrorException.

See Working with QFuture for further details.

This function was introduced in Esri::ArcGISRuntime 200.2.

See also FeatureServiceSessionType.

[override virtual, since Esri::ArcGISRuntime 100.1] Esri::ArcGISRuntime::RequestConfiguration ServiceFeatureTable::requestConfiguration() const

Reimplements: RemoteResource::requestConfiguration() const.

Returns the RequestConfiguration in use by this ServiceFeatureTable.

This function was introduced in Esri::ArcGISRuntime 100.1.

See also setRequestConfiguration().

[since Esri::ArcGISRuntime 100.9] Esri::ArcGISRuntime::ServiceGeodatabase *ServiceFeatureTable::serviceGeodatabase() const

Returns the service geodatabase this service feature table is part of.

This property is populated if the ServiceFeatureTable is provided by a layer or a table in a web map or if the ServiceFeatureTable is created using ServiceGeodatabase::table(qint64).

This function was introduced in Esri::ArcGISRuntime 100.9.

[override virtual, since Esri::ArcGISRuntime 100.10] void ServiceFeatureTable::setApiKey(const QString &apiKey)

Reimplements: ApiKeyResource::setApiKey(const QString &apiKey).

Sets the apiKey to apiKey.

This function was introduced in Esri::ArcGISRuntime 100.10.

See also apiKey.

void ServiceFeatureTable::setBufferFactor(double buffer)

Sets the bufferFactor to buffer.

See also bufferFactor.

[since Esri::ArcGISRuntime 100.14] void ServiceFeatureTable::setCredential(Esri::ArcGISRuntime::Credential *credential)

Sets the credential to credential.

This function was introduced in Esri::ArcGISRuntime 100.14.

See also credential.

[since Esri::ArcGISRuntime 100.2] void ServiceFeatureTable::setDefinitionExpression(const QString &expression)

Sets the definitionExpression to an expression.

This function was introduced in Esri::ArcGISRuntime 100.2.

See also definitionExpression.

void ServiceFeatureTable::setFeatureRequestMode(Esri::ArcGISRuntime::FeatureRequestMode mode)

Sets the featureRequestMode to mode.

See also featureRequestMode.

void ServiceFeatureTable::setGeodatabaseVersion(const QString &version)

Sets the geodatabaseVersion to version.

See also geodatabaseVersion.

[override virtual, since Esri::ArcGISRuntime 100.1] void ServiceFeatureTable::setRequestConfiguration(const Esri::ArcGISRuntime::RequestConfiguration &requestConfiguration)

Reimplements: RemoteResource::setRequestConfiguration(const Esri::ArcGISRuntime::RequestConfiguration &requestConfiguration).

Sets configuration parameters used for network requests sent by this ServiceFeatureTable to requestConfiguration.

This function was introduced in Esri::ArcGISRuntime 100.1.

See also requestConfiguration().

[since Esri::ArcGISRuntime 200.2] QFuture<void> ServiceFeatureTable::undoLocalEditsAsync()

Undoes all of the local edits since the last server acknowledgment.

undoLocalEditsAsync is meant to be used for single table workflows or tables without geodatabase behavior (see below). If the service which the table belongs to has geodatabase behavior (see below), it is highly recommended to use ServiceGeodatabase::undoLocalEditsAsync. Undoing edits in one table can cause data inconsistencies between the local cache and the service if undoLocalEditsAsync is used.

For example, when tables have a composite relationship, undoing only the origin feature would violate the composite relationship rule that an origin and destination feature must be either deleted together or not at all.

Areas which have geodatabase behavior:

• Composite relationships
• Annotation feature layers
• Utility network association deletion semantics
• Attribute rules

This method returns a QFuture for the asynchronous operation. Use future.then() to continue processing when the operation completes. Use future.onFailed() to handle exceptions of type ErrorException.

See Working with QFuture for further details.

This function was introduced in Esri::ArcGISRuntime 200.2.

See also FeatureServiceSessionType.

[override virtual] QUrl ServiceFeatureTable::url() const

Reimplements: RemoteResource::url() const.

Returns the URL of the service feature table.