Obsolete Members for OfflineMapTask

The following members of QML type OfflineMapTask are obsolete. They are provided to keep old source code working. We strongly advise against using them in new code.

Properties

Signals

Methods

  • DownloadPreplannedOfflineMapJob downloadPreplannedOfflineMap(PreplannedMapArea area, url downloadDirectoryPath, bool excludeBasemap=false) (obsolete)

Property Documentation

[default] credential : Credential

This property is obsolete. It is provided to keep old source code working. We strongly advise against using it in new code.

The credential for authenticating against a secured service.

This is only applicable if using a service that is secured.

Any credentials set here will not be honored. Set the credential on the PortalItem's Portal instead.


[default] requestConfiguration : RequestConfiguration

This property is obsolete. It is provided to keep old source code working. We strongly advise against using it in new code.

The configuration parameters used for network requests sent by this task.


Signal Documentation

credentialChanged()

This signal is obsolete. It is provided to keep old source code working. We strongly advise against using it in new code.

Emitted when the credential property changes.

Note: The corresponding handler is onCredentialChanged.


requestConfigurationChanged()

This signal is obsolete. It is provided to keep old source code working. We strongly advise against using it in new code.

Emitted when the requestConfiguration property changes.

Note: The corresponding handler is onRequestConfigurationChanged.


Method Documentation

DownloadPreplannedOfflineMapJob downloadPreplannedOfflineMap(PreplannedMapArea area, url downloadDirectoryPath, bool excludeBasemap=false)

This method is obsolete. It is provided to keep old source code working. We strongly advise against using it in new code.

Returns a job that is used to download the specified preplanned map area of an online map.

  • area Specifies the preplanned map area to be downloaded.
  • downloadDirectoryPath The url to a folder where the map content is stored on the device. For example, to create a new mobile map package my_mobile_map_package in a parent directory [my root path]/my_mobile_maps, this property would be [my root path]/my_mobile_maps/my_mobile_map_package.
  • excludeBasemap=false Specifies whether to exclude the basemap from the offline map. By default, this is set to false.

If you exclude the map's basemap from the download the offline map's size will be smaller and consequently the download process will be faster. If you already have a basemap stored locally on your device you can add that to the offline map.

Note: The job that is returned is not started and needs to be explicitly started. The job will fail if the last directory in the download directory path cannot be created or is not empty.

since Esri.ArcGISRuntime 100.10.

Please use downloadPreplannedOfflineMapWithParameters(DownloadPreplannedOfflineMapParameters, url).

This method does not support the scheduled updates work flow and will default to use Enums.PreplannedUpdateModeSyncWithFeatureServices.

An instance of DownloadPreplannedOfflineMapParameters can be created and populated as required. Alternatively the recommended work flow is to use createDefaultDownloadPreplannedOfflineMapParameters(PreplannedMapArea) and then make any adjustments. This will determine if scheduled updates are present and update the property DownloadPreplannedOfflineMapParameters::updateMode appropriately.

This method was introduced in Esri.ArcGISRuntime 100.2.


Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.