Obsolete Members for OfflineMapTask

OfflineMapTask

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

Public Functions

Member Function Documentation

OfflineMapTask::OfflineMapTask(Esri::ArcGISRuntime::Map *onlineMap, Esri::ArcGISRuntime::Credential *credential, QObject *parent = nullptr)

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

Constructor that accepts an online map, a credential, and a parent object.

• onlineMap - The online map to take offline.
• credential - The Credential to use to connect to a secured service.
• parent - The parent object of this OfflineMapTask.

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

[override virtual] Esri::ArcGISRuntime::Credential *OfflineMapTask::credential() const

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

Reimplements: RemoteResource::credential() const.

The credential for authenticating against a secured service.

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

Esri::ArcGISRuntime::DownloadPreplannedOfflineMapJob *OfflineMapTask::downloadPreplannedOfflineMap(Esri::ArcGISRuntime::PreplannedMapArea *area, const QString &downloadDirectoryPath)

This function 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 offline map area of an online map.

• area - Specifies the offline map area to be downloaded.
• downloadDirectoryPath - The path 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".

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 downloadPreplannedOfflineMap(DownloadPreplannedOfflineMapParameters). This method does not support the scheduled updates workflow and will default to use PreplannedUpdateMode::SyncWithFeatureServices. An instance of DownloadPreplannedOfflineMapParameters can be created and populated as required. Alternatively the recommended workflow 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 function was introduced in Esri::ArcGISRuntime 100.2.

Esri::ArcGISRuntime::DownloadPreplannedOfflineMapJob *OfflineMapTask::downloadPreplannedOfflineMap(Esri::ArcGISRuntime::PreplannedMapArea *area, const QString &downloadDirectoryPath, bool excludeBasemap)

This function 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 offline map area of an online map.

• area - Specifies the offline map area to be downloaded.
• downloadDirectoryPath - The path 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 - Specifies whether to exclude the basemap from the offline map.

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.

This function is deprecated in 100.4. Use downloadPreplannedOfflineMap accepting a DownloadPreplannedOfflineMapParameters instead.

This function was introduced in Esri::ArcGISRuntime 100.2.

[override virtual] Esri::ArcGISRuntime::RequestConfiguration OfflineMapTask::requestConfiguration() const

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

Reimplements: RemoteResource::requestConfiguration() const.

Returns the configuration parameters used for network requests sent by this task.

See also setRequestConfiguration().

[override virtual] void OfflineMapTask::setRequestConfiguration(const Esri::ArcGISRuntime::RequestConfiguration &requestConfiguration)

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

Reimplements: RemoteResource::setRequestConfiguration(const Esri::ArcGISRuntime::RequestConfiguration &requestConfiguration).

Sets the configuration parameters used for network requests sent by this task to requestConfiguration.

See also requestConfiguration().