Skip To Content ArcGIS for Developers Sign In Dashboard

SyncCapabilities Class

class Esri::ArcGISRuntime::SyncCapabilities

Information about the capabilities supported by a sync-enabled service. More...

Header: #include <SyncCapabilities>
Since: Esri::ArcGISRuntime 100.0

This class was introduced in Esri::ArcGISRuntime 100.0.

Public Functions

SyncCapabilities(Esri::ArcGISRuntime::SyncCapabilities &&other)
SyncCapabilities(const Esri::ArcGISRuntime::SyncCapabilities &other)
Esri::ArcGISRuntime::SyncCapabilities &operator=(Esri::ArcGISRuntime::SyncCapabilities &&other)
Esri::ArcGISRuntime::SyncCapabilities &operator=(const Esri::ArcGISRuntime::SyncCapabilities &other)
bool isEmpty() const
bool isSupportsAsync() const
bool isSupportsAttachmentsSyncDirection() const
bool isSupportsRegisteringExistingData() const
bool isSupportsRollbackOnFailure() const
bool isSupportsSyncDirectionControl() const
bool isSupportsSyncModelGeodatabase() const
bool isSupportsSyncModelLayer() const
bool isSupportsSyncModelNone() const

Detailed Description

Member Function Documentation

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

Move constructor from other SyncCapabilities.

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

Copy constructor from other SyncCapabilities.


Default constructor. Creates an empty SyncCapabilities.

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.



bool SyncCapabilities::isEmpty() const

Returns true if this SyncCapabilities is empty.

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.

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.

Feedback on this topic?