Obsolete Members for ServiceFeatureTable

  • ServiceFeatureTable
  • The following members of class ServiceFeatureTable are deprecated. They are provided to keep old source code working. We strongly advise against using them in new code.

    Public Functions

    (deprecated) Esri::ArcGISRuntime::TaskWatcher applyEdits()
    (deprecated) Esri::ArcGISRuntime::TaskWatcher loadOrRefreshFeatures(const QList<Esri::ArcGISRuntime::Feature *> &features)
    (deprecated) Esri::ArcGISRuntime::TaskWatcher populateFromService(const Esri::ArcGISRuntime::QueryParameters &parameters, bool clearCache, const QStringList &outFields)
    (deprecated) Esri::ArcGISRuntime::TaskWatcher queryFeatures(const Esri::ArcGISRuntime::QueryParameters &parameters, Esri::ArcGISRuntime::QueryFeatureFields queryFeatureFields)
    (deprecated) Esri::ArcGISRuntime::TaskWatcher queryRelatedFeatures(Esri::ArcGISRuntime::ArcGISFeature *originFeature, const Esri::ArcGISRuntime::RelatedQueryParameters &relatedQueryParameters, Esri::ArcGISRuntime::QueryFeatureFields queryFeatureFields)
    (deprecated) Esri::ArcGISRuntime::TaskWatcher undoLocalEdits()

    Signals

    (deprecated) void applyEditsCompleted(const QUuid &taskId, const QList<Esri::ArcGISRuntime::FeatureEditResult *> &featureEditResults)
    (deprecated) void loadOrRefreshFeaturesCompleted(const QUuid &taskId)
    (deprecated) void populateFromServiceCompleted(const QUuid &taskId, Esri::ArcGISRuntime::FeatureQueryResult *featureQueryResult)
    (deprecated) void undoLocalEditsCompleted(const QUuid &taskId)

    Member Function Documentation

    Esri::ArcGISRuntime::TaskWatcher ServiceFeatureTable::applyEdits()

    This function is deprecated. We strongly advise against using it in new code.

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

    ServiceFeatureTable::applyEdits 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::applyEdits 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 that have geodatabase behavior:

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

    Returns a TaskWatcher for the asynchronous operation.

    [signal] void ServiceFeatureTable::applyEditsCompleted(const QUuid &taskId, const QList<Esri::ArcGISRuntime::FeatureEditResult *> &featureEditResults)

    This function is deprecated. We strongly advise against using it in new code.

    Signal emitted when the table has finished applying edits back to the service.

    • taskId - The task ID for the asynchronous operation.
    • featureEditResults - The edit results indicating if any errors occurred when applying edits back to the service.

    The returned FeatureEditResult objects have the ServiceFeatureTable as their parent.

    See also Returned QObjects Parenting.

    [since Esri::ArcGISRuntime 100.3] Esri::ArcGISRuntime::TaskWatcher ServiceFeatureTable::loadOrRefreshFeatures(const QList<Esri::ArcGISRuntime::Feature *> &features)

    This function is deprecated. We strongly advise against using it in new code.

    Loads all attributes and geometries for features not loaded, and refetches attributes and geometries for previously loaded features.

    All features loaded or refreshed by this method will have m-values if defined by the service. Note that an m-value might be NaN. 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 ArcGISFeature::attachments to retrieve attachments.

    Returns a TaskWatcher for the asynchronous operation. Connect to the loadOrRefreshFeaturesCompleted signal to know when the task completes.

    features. The list of features to be loaded/refreshed. Any features which were not returned by the service will have their OBJECTID cleared to indicate they are no longer associated with the table.

    Note: This method will not refresh feature attachments. Use AttachmentListModel::fetchAttachments on each feature to retrieve attachments instead.

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

    This function was introduced in Esri::ArcGISRuntime 100.3.

    [signal, since Esri::ArcGISRuntime 100.3] void ServiceFeatureTable::loadOrRefreshFeaturesCompleted(const QUuid &taskId)

    This function is deprecated. We strongly advise against using it in new code.

    Signal emitted when the load or refresh features task has completed. with data acquired from the service.

    • taskId - The task ID for the asynchronous operation.

    This function was introduced in Esri::ArcGISRuntime 100.3.

    Esri::ArcGISRuntime::TaskWatcher ServiceFeatureTable::populateFromService(const Esri::ArcGISRuntime::QueryParameters &parameters, bool clearCache, const QStringList &outFields)

    This function is deprecated. We strongly advise against using it in new code.

    Queries the feature service and places the resulting features in the local table, which is cached for the duration of the session.

    • parameters. Options for controlling the operation.
    • clearCache. If true, ServiceFeatureTable::clearCache will be called before populating the local table. If false, the resulting features will be appended to the local table.
    • outFields. 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.

    The ServiceFeatureTable must have its ServiceFeatureTable::featureRequestMode set to FeatureRequestMode::ManualCache.

    This method is useful for non-geographic data. It is 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 when populating the local table. This is the same set of attributes described for FeatureRequestMode::OnInteractionCache or FeatureRequestMode.OnInteractionNoCache. See FeatureRequestMode.

    [signal] void ServiceFeatureTable::populateFromServiceCompleted(const QUuid &taskId, Esri::ArcGISRuntime::FeatureQueryResult *featureQueryResult)

    This function is deprecated. We strongly advise against using it in new code.

    Signal emitted when the table has finished populating with data acquired from the service.

    • taskId - The task ID for the asynchronous operation.
    • featureQueryResult - A result of features that satisfied the query and have been added to the table.

    The returned FeatureQueryResult objects have the ServiceFeatureTable as their parent.

    See also Returned QObjects Parenting.

    Esri::ArcGISRuntime::TaskWatcher ServiceFeatureTable::queryFeatures(const Esri::ArcGISRuntime::QueryParameters &parameters, Esri::ArcGISRuntime::QueryFeatureFields queryFeatureFields)

    This function is deprecated. We strongly advise against using it in new code.

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

    If the request mode of the table is FeatureRequestMode::ManualCache (see FeatureRequestMode), 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 (see FeatureRequestMode), the query is always performed on the server.

    The QueryFeatureFields constants control which fields will be included with the returned features:

    • A table whose feature request mode is FeatureRequestMode::manualCache contains all fields that you specified when calling ServiceFeatureTable::populateFromService().
    • A table whose feature request mode is FeatureRequestMode::OnInteractionCache or FeatureRequestMode::OnInteractionNoCache initially contains features with a minimum set of attributes required for rendering. You must load a feature to access all its attributes. The convenience constant QueryFeatureFields::LoadAll automatically loads the returned features into the local table, which makes all attributes available. See QueryFeatureFields.
    • parameters - The query parameters.
    • queryFeatureFields - Queries for related features in this service feature table using the provided parameters and query feature fields.

    Returns a TaskWatcher for the asynchronous task.

    [since Esri::ArcGISRuntime 100.1] Esri::ArcGISRuntime::TaskWatcher ServiceFeatureTable::queryRelatedFeatures(Esri::ArcGISRuntime::ArcGISFeature *originFeature, const Esri::ArcGISRuntime::RelatedQueryParameters &relatedQueryParameters, Esri::ArcGISRuntime::QueryFeatureFields queryFeatureFields)

    This function is deprecated. We strongly advise against using it in new code.

    Queries for features related to the given feature using the given related query parameters and query feature fields.

    • originFeature - The feature whose related features are to be queried.
    • relatedQueryParameters - The related query parameters.
    • queryFeatureFields - An enumeration indicating which fields to return from the query.

    Returns a TaskWatcher for the asynchronous task.

    This function was introduced in Esri::ArcGISRuntime 100.1.

    [since Esri::ArcGISRuntime 100.3] Esri::ArcGISRuntime::TaskWatcher ServiceFeatureTable::undoLocalEdits()

    This function is deprecated. We strongly advise against using it in new code.

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

    ServiceFeatureTable::undoLocalEdits 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, it is highly recommended to use ServiceGeodatabase::undoLocalEdits.

    Undoing edits in one table can cause data inconsistencies between the local cache and the service if this method 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

    Returns a TaskWatcher for the asynchronous task.

    This function was introduced in Esri::ArcGISRuntime 100.3.

    [signal] void ServiceFeatureTable::undoLocalEditsCompleted(const QUuid &taskId)

    This function is deprecated. We strongly advise against using it in new code.

    Signal emitted when all local edits since the last time applyEdits was called, are reverted.

    • taskId - The task ID for the asynchronous operation.

    Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.