ArcGIS Runtime SDK for iOS: AGSOfflineMapTask(AGSDeprecated) Category Reference
ArcGIS Runtime SDK for iOS  100.12
AGSOfflineMapTask(AGSDeprecated) Category Reference

Instance Methods

(AGSDownloadPreplannedOfflineMapJob *) - downloadPreplannedOfflineMapJobWithArea:downloadDirectory:
 
(AGSDownloadPreplannedOfflineMapJob *) - downloadPreplannedOfflineMapJobWithArea:downloadDirectory:excludeBasemap:
 

Method Documentation

◆ downloadPreplannedOfflineMapJobWithArea:downloadDirectory:

- (AGSDownloadPreplannedOfflineMapJob *) downloadPreplannedOfflineMapJobWithArea: (AGSPreplannedMapArea *)  preplannedMapArea
downloadDirectory: (NSURL *)  downloadDirectory 

Creates a job that is used to download the specified preplanned map area of an online map. The job that is returned is dormant 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.

Parameters
preplannedMapAreaSpecifies the preplanned map area to be downloaded.
downloadDirectoryThe 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".
Returns
An AGSDownloadPreplannedOfflineMapJob to download a preplanned map area.
Since
100.2
Deprecated:
100.10.0. Please use downloadPreplannedOfflineMapJobWithParameters:downloadDirectory: (AGSOfflineMapTask). This method does not support the scheduled updates workflow and will default to use AGSPreplannedUpdateModeSyncWithFeatureServices. An instance of AGSDownloadPreplannedOfflineMapParameters can be created and populated as required. Alternatively the recommended workflow is to use AGSOfflineMapTask::createDefaultDownloadPreplannedOfflineMapParametersWithPreplannedMapArea:completion: and then make any adjustments. This will determine if scheduled updates are present and update the property AGSDownloadPreplannedOfflineMapParameters::updateMode appropriately.

Extends class AGSOfflineMapTask.

◆ downloadPreplannedOfflineMapJobWithArea:downloadDirectory:excludeBasemap:

- (AGSDownloadPreplannedOfflineMapJob *) downloadPreplannedOfflineMapJobWithArea: (AGSPreplannedMapArea *)  preplannedMapArea
downloadDirectory: (NSURL *)  downloadDirectory
excludeBasemap: (BOOL)  excludeBasemap 

Creates a job that is used to download the specified preplanned map area of an online map but excludes the map's basemap.

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.

The job that is returned is dormant and needs to be explicitly started. The job will fail if the last directory in the downloadDirectory cannot be created or is not empty. Specifying excludeBasemap to YES will override the authored settings of preplanned map area and always exclude the basemap content.

Parameters
preplannedMapAreaSpecifies the preplanned map area to be downloaded.
downloadDirectoryThe 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".
excludeBasemapA boolean to exclude the basemap from the offline map.
Returns
An AGSDownloadPreplannedOfflineMapJob object to download a preplanned map area.
Since
100.2
Deprecated:
100.10.0. This method has been replaced by downloadPreplannedOfflineMapJobWithParameters:downloadDirectory: (AGSOfflineMapTask). Use AGSDownloadPreplannedOfflineMapParameters::includeBasemap to set basemap inclusion. Note reversal of logic from 'exclude basemap' to 'include basemap'.

Extends class AGSOfflineMapTask.