GenerateGeodatabaseParameters QML Type

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::supportsAttachmentsSyncDirection returns true).

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

• Enums.AttachmentSyncDirectionBidirectional - Attachment edits can be both uploaded from the client and downloaded from the service when syncing.
• Enums.AttachmentSyncDirectionUpload - 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.
• {Enums.AttachmentSyncDirection}{Enums.AttachmentSyncDirectionNone} - Attachment edits are never synced, from either the client or the server.

When GenerateGeodatabaseParameters::returnAttachments is set to true, you can set GenerateGeodatabaseParameters::attachmentSyncDirection to either Enums.AttachmentSyncDirectionBidirectional (default) or Enums.AttachmentSyncDirectionUpload. In this case, create replica includes attachments from the service. When GenerateGeodatabaseParameters::returnAttachments is set to false, you can set GenerateGeodatabaseParameters::attachmentSyncDirection to either Enums.AttachmentSyncDirectionUpload or Enums.AttachmentSyncDirectionDone (default). In this case, the geodatabase does not include attachments from the service.

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.

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.

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.

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

This property only applies if the feature service supports attachments.

Specifies 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::supportsAnnotations 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 property was introduced in Esri.ArcGISRuntime 100.14.

Specifies 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::supportsContingentValues 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 property was introduced in Esri.ArcGISRuntime 100.13.

Specifies 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::supportsDimensions 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 property was introduced in Esri.ArcGISRuntime 100.14.

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.

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

When this property is set to something other than Enums.UtilityNetworkSyncModeNone, GeodatabaseSyncTask::createDefaultGenerateGeodatabaseParameters(Geometry) will include all the data layers and tables in the feature service in the layerOptions. Since only the feature layers' schema is required to support querying associations or tracing offline, their feature data may be filtered out by:

• setting GenerateLayerOption::queryOption to Enums.GenerateLayerQueryOptionNone
• specifying a GenerateLayerOption::whereClause
• setting GenerateLayerOption::useGeometry to true Excluding data layers or including system layers of the feature service in the layerOptions will result in an error in the GenerateGeodatabaseJob.

Use SyncCapabilities to check which synchronization mode the feature service supports. If SyncCapabilities::supportsUtilityNetworkSystem is true, Enums.UtilityNetworkSyncModeSyncSystemTables may be used. If SyncCapabilities::supportsUtilityNetworkTopology is also true, Enums.UtilityNetworkSyncModeSyncSystemAndTopologyTables may be used.

Setting this property to something other than Enums.UtilityNetworkSyncModeNone allows the UtilityNetwork query associations offline. Setting this property to SyncCapabilities::supportsUtilityNetworkTopology also enables tracing offline. However, SyncCapabilities::supportsUtilityNetworkTopology does not allow editing the feature layers, which means syncModel must be set to Enums.SyncModelNone or such a combination will result in an error in the GenerateGeodatabaseJob.

The default value is Enums.UtilityNetworkSyncModeNone. Utility Network System data will not be included.

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

This property was introduced in Esri.ArcGISRuntime 100.11.

Emitted when the attachmentSyncDirection property of this GenerateGeodatabaseParameters changes.

Note: The corresponding handler is onAttachmentSyncDirectionChanged.

Emitted when the extent property of this GenerateGeodatabaseParameters changes.

Note: The corresponding handler is onExtentChanged.

Emitted when the layerOptions property of this GenerateGeodatabaseParameters changes.

Note: The corresponding handler is onLayerOptionsChanged.

Emitted when the outSpatialReference property of this GenerateGeodatabaseParameters changes.

Note: The corresponding handler is onOutSpatialReferenceChanged.

Emitted when the returnAttachments property of this GenerateGeodatabaseParameters changes.

Note: The corresponding handler is onReturnAttachmentsChanged.

Emitted when the syncAnnotations property changes.

Note: The corresponding handler is onSyncAnnotationsChanged.

This signal was introduced in Esri.ArcGISRuntime 100.14.

Emitted when the syncContingentValues property changes.

Note: The corresponding handler is onSyncContingentValuesChanged.

This signal was introduced in Esri.ArcGISRuntime 100.13.

Emitted when the syncDimensions property changes.

Note: The corresponding handler is onSyncDimensionsChanged.

This signal was introduced in Esri.ArcGISRuntime 100.14.

Emitted when the syncModel property of this GenerateGeodatabaseParameters changes.

Note: The corresponding handler is onSyncModelChanged.

Emitted when the utilityNetworkSyncMode property changes.

Note: The corresponding handler is onUtilityNetworkSyncModeChanged.

This signal was introduced in Esri.ArcGISRuntime 100.11.

Creates a deep copy of this object.

This method was introduced in Esri.ArcGISRuntime 200.1.