Obsolete Members for OfflineMapTask

OfflineMapTask

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

Public Functions

Signals

Member Function Documentation

[since Esri::ArcGISRuntime 100.5] Esri::ArcGISRuntime::TaskWatcher OfflineMapTask::createDefaultDownloadPreplannedOfflineMapParameters(Esri::ArcGISRuntime::PreplannedMapArea *area)

This function is deprecated. We strongly advise against using it in new code.

Asynchronously retrieves a DownloadPreplannedOfflineMapParameters with default values appropriate for taking the specified area offline.

• area - The offline map area that is to be downloaded from the online map.

Returns a TaskWatcher for this asynchronous operation.

If the web map author has set a reference basemap filename, this will be set into the DownloadPreplannedOfflineMapParameters::referenceBasemapFilename property.

This function was introduced in Esri::ArcGISRuntime 100.5.

[signal, since Esri::ArcGISRuntime 100.5] void OfflineMapTask::createDefaultDownloadPreplannedOfflineMapParametersCompleted(const QUuid &taskId, const Esri::ArcGISRuntime::DownloadPreplannedOfflineMapParameters &parameters)

This function is deprecated. We strongly advise against using it in new code.

Emitted when the createDefaultDownloadPreplannedOfflineMapParameters operation completes.

• taskId - The task ID of the asynchronous operation.
• parameters - The default parameters returned from the service.

This function was introduced in Esri::ArcGISRuntime 100.5.

Esri::ArcGISRuntime::TaskWatcher OfflineMapTask::createDefaultGenerateOfflineMapParameters(const Esri::ArcGISRuntime::Geometry &areaOfInterest)

This function is deprecated. We strongly advise against using it in new code.

Returns a TaskWatcher of GenerateOfflineMapParameters created from the specified area of interest.

• areaOfInterest - the region of the online map that is to be taken offline.

The supported geometry types for the area of interest are Envelope and Polygon. The area of interest must have a spatial reference.

Where a Polygon is supplied, features and tiles will be filtered according to the polygon geometry, which can help reduce the size of the resulting offline map. Note that the filtered set of tiles may vary, depending on the underlying service.

The returned parameters min scale and max scale are zero so data will be taken at the full range of scales the services support.

The returned GenerateOfflineMapParameters has its itemInfo property initialized from the offline map task's portal item, if that is set.

The ItemInfo's thumbnail will be copied from the portal item's thumbnail.

The default parameters will be populated using the values in the online map's OfflineSettings (if present).

If the map being taken offline contains a UtilityNetwork and is in an ArcGIS Enterprise 11.1 or later service, the Offline Capability selected for the UtilityNetwork such as "Trace utility network features" will automatically be reflected in the default parameters created by this method. If the map being taken offline contains a UtilityNetwork and is in an earlier version of ArcGIS Enterprise, the GenerateGeodatabaseParameters::utilityNetworkSyncMode property is set to UtilityNetworkSyncMode::SyncSystemTables for the Geodatabase containing the UtilityNetwork. Use createGenerateOfflineMapParameterOverridesAsync to change the UtilityNetworkSyncMode if desired.

[since Esri::ArcGISRuntime 100.4] Esri::ArcGISRuntime::TaskWatcher OfflineMapTask::createDefaultGenerateOfflineMapParameters(const Esri::ArcGISRuntime::Geometry &areaOfInterest, double minScale, double maxScale)

This function is deprecated. We strongly advise against using it in new code.

Asynchronously retrieves a GenerateOfflineMapParameters populated with default settings for a service, created from the specified area of interest, min scale and max scale.

• areaOfInterest - The geographic area of interest for the offline map.
• minScale - The minimum scale for offline tile caches. Use 0 for all far out levels. Sets the property GenerateOfflineMapParameters::minScale.
• maxScale - The maximum scale for offline tile caches. Use 0 for all closer in detailed levels. Sets the property GenerateOfflineMapParameters::maxScale.

Returns a TaskWatcher for this asynchronous operation.

This will populate the parameters with default values for all the input parameters defined by the service. If the service defines a default value for a parameter, this will be used. If no default value is defined for a parameter, it will be given an appropriate default for its type: Boolean parameters false, string parameters an empty string, and numerical parameters zero.

The supported geometry types for the area of interest are Envelope and Polygon. The area of interest must have a spatial reference. Where a Polygon is supplied, features and tiles will be filtered according to the polygon geometry, which can help reduce the size of the resulting offline map. Note that the filtered set of tiles may vary, depending on the underlying service.

The returned GenerateOfflineMapParameters has its itemInfo property initialized from the offline map task's portal item, if that is set. The item info's thumbnail will be copied from the portal item's thumbnail.

If the map being taken offline contains a UtilityNetwork and is in an ArcGIS Enterprise 11.1 or later service, the Offline Capability selected for the UtilityNetwork such as "Trace utility network features" will automatically be reflected in the default parameters created by this method. If the map being taken offline contains a UtilityNetwork and is in an earlier version of ArcGIS Enterprise, the GenerateGeodatabaseParameters::utilityNetworkSyncMode property is set to UtilityNetworkSyncMode::SyncSystemTables for the Geodatabase containing the UtilityNetwork. Use createGenerateOfflineMapParameterOverridesAsync to change the UtilityNetworkSyncMode if desired.

This function was introduced in Esri::ArcGISRuntime 100.4.

[signal] void OfflineMapTask::createDefaultGenerateOfflineMapParametersCompleted(const QUuid &taskId, const Esri::ArcGISRuntime::GenerateOfflineMapParameters &parameters)

This function is deprecated. We strongly advise against using it in new code.

Emitted when the createDefaultGenerateOfflineMapParameters operation completes.

• taskId - The task ID of the asynchronous operation.
• parameters - The default parameters returned from the service.

[since Esri::ArcGISRuntime 100.4] Esri::ArcGISRuntime::TaskWatcher OfflineMapTask::createGenerateOfflineMapParameterOverrides(const Esri::ArcGISRuntime::GenerateOfflineMapParameters &parameters)

This function is deprecated. We strongly advise against using it in new code.

Asynchronously retrieves a GenerateOfflineMapParameterOverrides created from the specified parameters.

• parameters - The generate offline map parameters from which the overrides will be populated.

When the task completes GenerateOfflineMapParameterOverrides will be populated reflecting the values in the GenerateOfflineMapParameters parameters. The overrides may be inspected and modified to change the offline data before passing onto creating a job with OfflineMapTask::generateOfflineMap.

If there are errors with loading individual layers or tables, or they cannot be taken offline due to service settings, the outcome depends on the value of GenerateOfflineMapParameters::isContinueOnErrors.

• If this property is true, the overrides correspond to the remaining layers and tables that can go offline. The resulting offline map will not contain the layers or tables which had errors.
• If this property is false, the task will fail with an Error from the failed layer or table.

To check upfront which layers or tables are valid for taking offline, see offlineMapCapabilitiesAsync.

Returns a TaskWatcher for this asynchronous operation.

If GenerateOfflineMapParameters::referenceBasemapDirectory is set, the overrides corresponding to online basemap layers will be omitted, since no basemap layers will be downloaded.

The returned GenerateOfflineMapParameterOverrides object has the OfflineMapTask as its parent.

This function was introduced in Esri::ArcGISRuntime 100.4.

See also Returned QObjects Parenting.

[signal, since Esri::ArcGISRuntime 100.4] void OfflineMapTask::createGenerateOfflineMapParameterOverridesCompleted(const QUuid &taskId, Esri::ArcGISRuntime::GenerateOfflineMapParameterOverrides *parameterOverrides)

This function is deprecated. We strongly advise against using it in new code.

Emitted when the createGenerateOfflineMapParameterOverrides operation completes.

• taskId - The task ID of the asynchronous operation.
• parameterOverrides - A set of overrides to allow more fine-grained control of how individual services are taken offline.

The returned GenerateOfflineMapParameterOverrides object has the OfflineMapTask as its parent.

This function was introduced in Esri::ArcGISRuntime 100.4.

See also Returned QObjects Parenting.

Esri::ArcGISRuntime::TaskWatcher OfflineMapTask::offlineMapCapabilities(const Esri::ArcGISRuntime::GenerateOfflineMapParameters &parameters)

This function is deprecated. We strongly advise against using it in new code.

Asynchronously retrieves information on which layers will be included in an offline map.

• parameters - The parameters to use to get the offline map capabilities.

Returns a TaskWatcher for this asynchronous operation.

[signal] void OfflineMapTask::offlineMapCapabilitiesCompleted(const QUuid &taskId, const Esri::ArcGISRuntime::OfflineMapCapabilities &capabilities)

This function is deprecated. We strongly advise against using it in new code.

Emitted when the offlineMapCapabilities operation completes.

• taskId - The task ID of the asynchronous operation.
• capabilities - The information about which layers and tables in the map can be taken offline.

[since Esri::ArcGISRuntime 100.2] Esri::ArcGISRuntime::TaskWatcher OfflineMapTask::preplannedMapAreas()

This function is deprecated. We strongly advise against using it in new code.

Asynchronously retrieves a list of preplanned map areas, if there are any.

Returns a TaskWatcher for this asynchronous operation.

This function was introduced in Esri::ArcGISRuntime 100.2.

[signal, since Esri::ArcGISRuntime 100.2] void OfflineMapTask::preplannedMapAreasCompleted(const QUuid &taskId)

This function is deprecated. We strongly advise against using it in new code.

Emitted when the preplannedMapAreas operation completes.

• taskId - The task ID of the asynchronous operation.

This function was introduced in Esri::ArcGISRuntime 100.2.