SyncCapabilities Class

Member Function Documentation

SyncCapabilities::SyncCapabilities()

Default constructor. Creates an empty SyncCapabilities.

SyncCapabilities::SyncCapabilities(const Esri::ArcGISRuntime::SyncCapabilities &other)

Copy constructor from other SyncCapabilities.

[noexcept] SyncCapabilities::SyncCapabilities(Esri::ArcGISRuntime::SyncCapabilities &&other)

Move constructor from other SyncCapabilities.

[noexcept] SyncCapabilities::~SyncCapabilities()

Destructor.

bool SyncCapabilities::isEmpty() const

Returns true if this SyncCapabilities is empty.

[since Esri::ArcGISRuntime 100.14] bool SyncCapabilities::isSupportsAnnotations() const

Returns if Annotation data is available for downloading.

Feature layers and tables are always included in the generation and synchronization of the geodatabase. This property indicates whether Annotation data is also available from the service, for generation of, or downloading to, an offline geodatabase.

After this data is taken offline to a local geodatabase, any inserts, edits, or deletions will NOT be applied to the server data when the geodatabase is re-synchronized. If features linked to the annotation have been changed, the server WILL apply the feature-linked annotation updates. Another download from the server will replace any offline inserts, edits, or deletions of Annotation features.

This function was introduced in Esri::ArcGISRuntime 100.14.

See also GenerateGeodatabaseParameters::isSyncAnnotations.

bool SyncCapabilities::isSupportsAsync() const

Returns true if the service supports asynchronous operations. This avoids server timeouts.

bool SyncCapabilities::isSupportsAttachmentsSyncDirection() const

Returns true if the service supports options to define how attachments will be synced.

[since Esri::ArcGISRuntime 200.6] bool SyncCapabilities::isSupportsAttributeRules() const

Returns true if the service supports creating a replica with attribute rule data, false otherwise

Feature layers and tables are always included in the generation and synchronization of the geodatabase. If the value is true, you can generate an offline geodatabase and synchronize it using the service's attribute rule data.

This function was introduced in Esri::ArcGISRuntime 200.6.

See also GenerateGeodatabaseParameters::isSyncAttributeRules.

[since Esri::ArcGISRuntime 200.5] bool SyncCapabilities::isSupportsBranchVersionReconcile() const

Returns true if reconciling replica branch versions with default branch upon sync is supported, false otherwise. If this value is true, SyncGeodatabaseParameters::isReconcileBranchVersion can be used with GeodatabaseSyncTask.

This function was introduced in Esri::ArcGISRuntime 200.5.

See also SyncGeodatabaseParameters::isReconcileBranchVersion.

[since Esri::ArcGISRuntime 100.13] bool SyncCapabilities::isSupportsContingentValues() const

Returns if Contingent Value data is available.

Feature layers and tables are always included in the generation and synchronization of the geodatabase. This property indicates whether Contingent Value data is also available from the service, for generation of an offline geodatabase and for resynchronization.

This function was introduced in Esri::ArcGISRuntime 100.13.

See also GenerateGeodatabaseParameters::isSyncContingentValues.

[since Esri::ArcGISRuntime 100.14] bool SyncCapabilities::isSupportsDimensions() const

Returns if Dimension data is available.

Feature layers and tables are always included in the generation and synchronization of the geodatabase. This property indicates whether Dimension data is also available from the service, for generating an offline geodatabase and for resynchronization.

This function was introduced in Esri::ArcGISRuntime 100.14.

See also GenerateGeodatabaseParameters::isSyncDimensions.

bool SyncCapabilities::isSupportsRegisteringExistingData() const

Returns true if the service supports registering an existing mobile geodatabase (*.geodatabase file) as new a sync-enabled geodatabase.

This is useful when you already have a geodatabase that you want to sync on multiple devices independently without affecting each other.

bool SyncCapabilities::isSupportsRollbackOnFailure() const

Returns true if the service supports rolling back edits in case of a failure during sync operations.

bool SyncCapabilities::isSupportsSyncDirectionControl() const

Returns true if the service allows the client application to control direction of sync

This directions include upload only, download only, or bi-directional.

bool SyncCapabilities::isSupportsSyncModelGeodatabase() const

Returns true if the service supports sync capabilities for the entire sync-enabled geodatabase.

All layers in the geodatabase will be synchronized together in the same direction.

bool SyncCapabilities::isSupportsSyncModelLayer() const

Returns true if the service supports sync capabilities independently on a layer-by-layer basis in the sync-enabled geodatabase.

For example, one layer can upload changes while another downloads during sync. A perLayer sync model also allows clients to limit the sync to a subset of layers in the geodatabase.

bool SyncCapabilities::isSupportsSyncModelNone() const

Returns true if no sync model is supported.

[since Esri::ArcGISRuntime 100.11] bool SyncCapabilities::isSupportsUtilityNetworkSystem() const

Returns if Utility Network System data is available.

Feature layers and tables are always included in the generation and synchronization of the geodatabase. This property indicates whether Utility Network System data is also available from the service, for generation of an offline geodatabase, and for resynchronization.

This function was introduced in Esri::ArcGISRuntime 100.11.

See also GenerateGeodatabaseParameters::utilityNetworkSyncMode.

[since Esri::ArcGISRuntime 200.1] bool SyncCapabilities::isSupportsUtilityNetworkTopology() const

Returns if utility network topology data is available.

When syncing Utility Network data, feature layers and tables are always included in the generation and synchronization of the geodatabase. This property indicates whether utility network topology data is also available from the service, for generation of an offline geodatabase and for resynchronization.

This function was introduced in Esri::ArcGISRuntime 200.1.

See also GenerateGeodatabaseParameters::utilityNetworkSyncMode.

[since Esri::ArcGISRuntime 200.6] bool SyncCapabilities::isSupportsUtilityNetworkTopologySync() const

Returns true if the available utility network topology data support synchronization in any direction, false otherwise.

If the value is true, utility network topology data can be taken offline with SyncModel::Geodatabase. The downloaded geodatabase supports editing and synchronization in any direction - SyncDirection::Download, SyncDirection::Upload, SyncDirection::Bidirectional.

If the value is false, utility network topology data can only be taken offline with SyncModel::Geodatabase if isSupportsUtilityNetworkTopologySyncDownloadOnly is true. The downloaded geodatabase cannot be edited directly but it can incorporate edits made on the service using SyncDirection::Download.

If isSupportsUtilityNetworkTopologySyncDownloadOnly is false, the utility network topology data can only be taken offline with SyncModel::None. In this situation, the geodatabase is read-only and does not support synchronization. To integrate updates from the service into the geodatabase, the current geodatabase needs to be replaced by downloading it again.

This function was introduced in Esri::ArcGISRuntime 200.6.

See also isSupportsUtilityNetworkTopology, isSupportsUtilityNetworkTopologySyncDownloadOnly, GenerateGeodatabaseParameters::syncModel, and SyncGeodatabaseParameters::geodatabaseSyncDirection.

[since Esri::ArcGISRuntime 200.6] bool SyncCapabilities::isSupportsUtilityNetworkTopologySyncDownloadOnly() const

Returns true if the available utility network topology data support download-only synchronization, false otherwise.

If the value is true, utility network topology data can be taken offline with SyncModel::Geodatabase. The downloaded geodatabase cannot be edited directly. If you want to incorporate edits made on the service, you can synchronize the geodatabase using SyncDirection::Download.

If the value is false, utility network topology data can only be taken offline with SyncModel::Geodatabase if isSupportsUtilityNetworkTopologySync is true. The downloaded geodatabase supports editing and synchronization in any direction - SyncDirection::Download, SyncDirection::Upload, SyncDirection::Bidirectional.

When isSupportsUtilityNetworkTopologySync is false, utility network topology data can only be taken offline with SyncModel::None. In this situation, the geodatabase is read-only and does not support synchronization. To integrate updates from the service into the geodatabase, the current geodatabase needs to be replaced by downloading it again.

This function was introduced in Esri::ArcGISRuntime 200.6.

See also isSupportsUtilityNetworkTopology, isSupportsUtilityNetworkTopologySync, GenerateGeodatabaseParameters::syncModel, and SyncGeodatabaseParameters::geodatabaseSyncDirection.

[noexcept] Esri::ArcGISRuntime::SyncCapabilities &SyncCapabilities::operator=(Esri::ArcGISRuntime::SyncCapabilities &&other)

Move operator from other SyncCapabilities.

Esri::ArcGISRuntime::SyncCapabilities &SyncCapabilities::operator=(const Esri::ArcGISRuntime::SyncCapabilities &other)

Assignment operator from other SyncCapabilities.