Skip To Content ArcGIS for Developers Sign In Dashboard

GenerateGeodatabaseParameters QML Type

The parameters to sync data of a sync-enabled geodatabase. More...

Import Statement: import Esri.ArcGISRuntime 100.8
Since: Esri.ArcGISRuntime 100.0




Detailed Description

GenerateGeodatabaseParameters are used with GeodatabaseSyncTask::generateGeodatabase to generate sync-enabled geodatabases from supporting ArcGIS Feature services.

Note: Rather than constructing one of these directly, consider using the convenience method GeodatabaseSyncTask::createDefaultGenerateGeodatabaseParameters. It will create a GenerateGeodatabaseParameters object initialized with appropriate parameters based on the supported capabilities and data of the ArcGIS Feature Service.

This QML type supports the following default properties. A default property may be declared inside another declared object without being assigned explicitly to a property.

Property Documentation

attachmentSyncDirection : AttachmentSyncDirection

The attachment sync direction.

[default] extent : Geometry

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::useGeometry to false.

layerOptions : list<GenerateLayerOption>

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

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 GenerateLayerOption.

[default] outSpatialReference : SpatialReference

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

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

returnAttachments : bool

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

This property only applies if the feature service supports attachments.

syncModel : SyncModel

The SyncModel.

This property specifies whether the geodatabase should be configured to sync with the service as a whole (Enums.SyncModelGeodatabase) or by individual layer or table (Enums.SyncModelLayer).

See also Enums.SyncModel.

Signal Documentation


Emitted when the attachmentSyncDirection property of this GenerateGeodatabaseParameters changes.


Emitted when the extent property of this GenerateGeodatabaseParameters changes.


Emitted when the layerOptions property of this GenerateGeodatabaseParameters changes.


Emitted when the outSpatialReference property of this GenerateGeodatabaseParameters changes.


Emitted when the returnAttachments property of this GenerateGeodatabaseParameters changes.


Emitted when the syncModel property of this GenerateGeodatabaseParameters changes.

Feedback on this topic?