GenerateGeodatabaseParameters Class

Member Function Documentation

GenerateGeodatabaseParameters::GenerateGeodatabaseParameters(Esri::ArcGISRuntime::GenerateGeodatabaseParameters &&other)

Move constructor from other GenerateGeodatabaseParameters.

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

Copy constructor from other GenerateGeodatabaseParameters.

GenerateGeodatabaseParameters::GenerateGeodatabaseParameters()

Default constructor.

Esri::ArcGISRuntime::GenerateGeodatabaseParameters &GenerateGeodatabaseParameters::operator=(Esri::ArcGISRuntime::GenerateGeodatabaseParameters &&other)

Move operator from other GenerateGeodatabaseParameters.

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

Assignment operator from other GenerateGeodatabaseParameters.

GenerateGeodatabaseParameters::~GenerateGeodatabaseParameters()

Destructor.

Esri::ArcGISRuntime::AttachmentSyncDirection GenerateGeodatabaseParameters::attachmentSyncDirection() const

Returns the attachment sync direction.

See also setAttachmentSyncDirection().

Esri::ArcGISRuntime::Geometry GenerateGeodatabaseParameters::extent() const

Returns the geographic extent within which features will be included in the sync-enabled geodatabase.

To include non-spatial records, you must set up the LayerOptions for that layer to include a GenerateLayerOption::whereClause and set GenerateLayerOption::isUseGeometry to false.

See also setExtent().

bool GenerateGeodatabaseParameters::isEmpty() const

Returns whether this GenerateGeodatabaseParameters is empty.

bool GenerateGeodatabaseParameters::isReturnAttachments() const

Returns whether the sync-enabled geodatabase should contain attachments for the features that are included.

bool GenerateGeodatabaseParameters::isSyncAnnotations() const

Returns whether Annotation data is to be included from the service, when generating, or downloading to, an offline geodatabase.

Feature layers and tables are always included in the generation and synchronization of the geodatabase. Annotation data can be optionally included when downloading from the service.

After this data is taken offline to a local geodatabase, any subsequent inserts, edits or deletions will NOT be applied to the server data when 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.

The default value is true. Annotation data will be included.

SyncCapabilities::isSupportsAnnotations can be used to check whether Annotation data is available from the service.

This property can be used at the same time as specifying other additional data types to be included.

This function was introduced in Esri::ArcGISRuntime 100.14.

bool GenerateGeodatabaseParameters::isSyncContingentValues() const

Returns whether Contingent Value data is to be included from the service, when generating, or synchronizing with, an offline geodatabase.

Feature layers and tables are always included in the generation and synchronization of the geodatabase. Contingent Value data can be optionally included.

The default value is false. Contingent Value data will not be included.

SyncCapabilities::isSupportsContingentValues can be used to check whether Contingent Value data is available from the service.

This property can be used at the same time as specifying other additional data types to be included.

This function was introduced in Esri::ArcGISRuntime 100.13.

bool GenerateGeodatabaseParameters::isSyncDimensions() const

Returns whether Dimension data is to be included from the service, when generating, or synchronizing with, an offline geodatabase.

Feature layers and tables are always included in the generation and synchronization of the geodatabase. Dimension data can be optionally included.

The default value is true. Dimension data will be included.

SyncCapabilities::isSupportsDimensions can be used to check whether Dimension data is available from the service.

This property can be used at the same time as specifying other additional data types to be included.

This function was introduced in Esri::ArcGISRuntime 100.14.

QList<Esri::ArcGISRuntime::GenerateLayerOption> GenerateGeodatabaseParameters::layerOptions() const

Returns the options specifiying how to filter features from individual layers for inclusion into the geodatabase.

See also setLayerOptions().

Esri::ArcGISRuntime::SpatialReference GenerateGeodatabaseParameters::outSpatialReference() const

Returns the spatial reference in which you would like the generated geodatabase.

See also setOutSpatialReference().

void GenerateGeodatabaseParameters::setAttachmentSyncDirection(Esri::ArcGISRuntime::AttachmentSyncDirection attachmentSyncDirection)

Sets the attachment sync direction.

• attachmentSyncDirection - The directions to sync attachments.

This property specifies how the geodatabase should be configured to sync attachment data with its originating service. This parameter is available when the service resource sync capabilities includes supports attachmentsSyncDirection (SyncCapabilities::isSupportsAttachmentsSyncDirection returns true).

attachmentSyncDirection defines how attachments will be synced and is only applicable if the feature service has attachments:

• AttachmentSyncDirection::Bidirectional - Attachment edits can be both uploaded from the client and downloaded from the service when syncing.
• AttachmentSyncDirection::Upload - Attachment edits can only be uploaded from the client when syncing. This is useful in cases where the data collector does not want to consume space with attachments from the service, but does need to collect new attachments.
• {AttachmentSyncDirection}{AttachmentSyncDirection::None} - Attachment edits are never synced, from either the client or the server.

When GenerateGeodatabaseParameters::isReturnAttachments is set to true, you can set GenerateGeodatabaseParameters::attachmentSyncDirection to either AttachmentSyncDirection::Bidirectional (default) or AttachmentSyncDirection::Upload. In this case, create replica includes attachments from the service.

When GenerateGeodatabaseParameters::isReturnAttachments is set to false, you can set GenerateGeodatabaseParameters::attachmentSyncDirection to either AttachmentSyncDirection::Upload or AttachmentSyncDirection::Done (default). In this case, the geodatabase does not include attachments from the service.

See also attachmentSyncDirection().

void GenerateGeodatabaseParameters::setExtent(const Esri::ArcGISRuntime::Geometry &extent)

Sets the geographic extent of features to include in the geodatabase.

• extent - The geographic extent.

See also extent().

void GenerateGeodatabaseParameters::setLayerOptions(const QList<Esri::ArcGISRuntime::GenerateLayerOption> &generateLayerOptions)

Sets the options specifiying how to filter features from individual layers for inclusion into the geodatabase.

• generateLayerOptions - The options specifiying how to filter features.

If not specified, all features within the extent are included. For non-spatial records, set GenerateLayerOption::useGeometry to false and provide a GenerateLayerOption::whereClause.

See also layerOptions().

void GenerateGeodatabaseParameters::setOutSpatialReference(const Esri::ArcGISRuntime::SpatialReference &outSpatialReference)

Sets the spatial reference for the generated geodatabase.

• outSpatialReference - The output spatial reference.

If the data on the server is not in this spatial reference, it will be reprojected before being included in the geodatabase.

See also outSpatialReference().

void GenerateGeodatabaseParameters::setReturnAttachments(bool returnAttachments)

Sets whether the sync-enabled geodatabase should contain attachments for the features that are included.

• returnAttachments - Whether to include attachments.

This property only applies if the feature service supports attachments.

See also isReturnAttachments().

void GenerateGeodatabaseParameters::setSyncAnnotations(bool syncAnnotations)

Sets the syncAnnotations to syncAnnotations.

This function was introduced in Esri::ArcGISRuntime 100.14.

See also isSyncAnnotations.

void GenerateGeodatabaseParameters::setSyncContingentValues(bool syncContingentValues)

Sets the syncContingentValues to syncContingentValues.

This function was introduced in Esri::ArcGISRuntime 100.13.

See also isSyncContingentValues.

void GenerateGeodatabaseParameters::setSyncDimensions(bool syncDimensions)

Sets the syncDimensions to syncDimensions.

This function was introduced in Esri::ArcGISRuntime 100.14.

See also isSyncDimensions.

void GenerateGeodatabaseParameters::setSyncModel(Esri::ArcGISRuntime::SyncModel syncModel)

Sets the SyncModel.

• syncModel - The sync model.

This property specifies whether the geodatabase should be configured to sync with the service as a whole (SyncModel::Geodatabase) or by individual layer or table (SyncModel::Layer).

See also syncModel().

void GenerateGeodatabaseParameters::setUtilityNetworkSyncMode(Esri::ArcGISRuntime::UtilityNetworkSyncMode utilityNetworkSyncMode)

Sets the utilityNetworkSyncMode to utilityNetworkSyncMode.

This function was introduced in Esri::ArcGISRuntime 100.11.

See also utilityNetworkSyncMode.

Esri::ArcGISRuntime::SyncModel GenerateGeodatabaseParameters::syncModel() const

Returns the SyncModel.

See also setSyncModel().

Esri::ArcGISRuntime::UtilityNetworkSyncMode GenerateGeodatabaseParameters::utilityNetworkSyncMode() const

Returns the generation and synchronization mode of Utility Network data from the service to an offline geodatabase.

Feature layers and tables are always included in the generation and synchronization of the geodatabase. Utility Network System data can be optionally included.

The default value is UtilityNetworkSyncMode::None. Utility Network System data will not be included.

This property can be used while specifying other additional data types to be included.

This function was introduced in Esri::ArcGISRuntime 100.11.

See also setUtilityNetworkSyncMode().