updateCapabilities

Describes the methods for obtaining updates that are supported for this offline map area. There are two approaches for updating the features in a preplanned offline map area:

  • Syncing directly with feature services.

  • Downloading scheduled updates (or update packages) from the online map area.

Choose the approach that best suits your workflow, then select the appropriate DownloadPreplannedOfflineMapParameters.updateMode. For more details on how to update an offline map, see the OfflineMapSyncTask.

If OfflineMapUpdateCapabilities.supportsSyncWithFeatureServices is true, you can sync directly with feature services. This mode gives you full control over when you upload and download changes. However, performing a download sync places significant load on the backing feature service, so this approach does not scale well for very large deployments. Set the DownloadPreplannedOfflineMapParameters.updateMode to PreplannedUpdateMode.SyncWithFeatureServices to use this approach.

If OfflineMapUpdateCapabilities.supportsScheduledUpdatesForFeatures is true, you can download read-only update packages from the online map area. Updates are prepared on a regular schedule and cached for download by all users of the offline map area. Sharing a single set of cached updates, rather than performing individual sync operations, reduces the load on the back-end services. This approach is scalable for large deployments but does not support offline editing. Set the DownloadPreplannedOfflineMapParameters.updateMode to PreplannedUpdateMode.DownloadScheduledUpdates to use this approach.

Note that scheduled updates is an optimization that must be enabled by the web map author when the map area is created.

If both of the above OfflineMapUpdateCapabilities are true, and the feature services in your online map support creating new features, you can adopt a hybrid update model where you download read-only update packages while uploading new features directly to the feature service. This approach combines the scalability of downloading scheduled updates with the ability to collect data in the field. However, note that this approach is strictly add only, meaning that you cannot delete or edit features once they have been uploaded to the feature service. Set the DownloadPreplannedOfflineMapParameters.updateMode to PreplannedUpdateMode.DownloadScheduledUpdatesAndUploadNewFeatures to use this approach.

This property will return null until the preplanned map area is loaded.

Since

200.1.0