The parameters that specify how an offline map area is downloaded from an online map using a DownloadPreplannedOfflineMapJob. The online map must be a web map either on ArcGIS Online or ArcGIS Enterprise. Note that the API refers to an offline map area as a PreplannedMapArea.

To generate default parameters that match the online map's offline settings, call OfflineMapTask.createDefaultDownloadPreplannedOfflineMapParameters(PreplannedMapArea). You can then modify the parameters with any desired changes. Alternatively, you can generate an empty set of parameters using DownloadPreplannedOfflineMapParameters.DownloadPreplannedOfflineMapParameters() and set the parameters individually. To create a DownloadPreplannedOfflineMapJob, pass the parameters to the OfflineMapTask.createDownloadPreplannedOfflineMapJob(DownloadPreplannedOfflineMapParameters, String) method and provide a path to a folder where the map content is stored on the device.




Link copied to clipboard

Creates a download preplanned offline map parameters object.

constructor(preplannedMapArea: PreplannedMapArea)

Creates a download preplanned offline map parameters object with the given offline map area.


Link copied to clipboard

Indicates whether or not the download preplanned offline map job should continue running in the event of failure to take a layer offline. If this property is true, failure to take a layer or table offline will not fail the job, the failure will be exposed in the job result. If this property is false, failure to take a layer or table offline will fail the job and no more layers or tables will be taken offline. The layer or table's error will be available as the job's error. The default value is true.

Link copied to clipboard

Indicates whether or not a basemap will be included in the offline map. If you do not want a basemap in the offline map then set this property to FALSE.

Link copied to clipboard

The offline map area that will be downloaded for offline use.

Link copied to clipboard

The path to a directory on the device where the local basemap file is located. Set this property to use a basemap which is already on the device (rather than downloading it). The directory should only be set when DownloadPreplannedOfflineMapParameters.referenceBasemapFilename is defined.

Link copied to clipboard

The name of a local basemap file on the device which can be used rather than downloading an online basemap. The local basemap filename must end with .tpk, .tpkx or .vtpk since these are the supported file formats. This property can be read directly from settings applied by the author of the online web map (see OfflineSettings) or set by user code to a file known to be on the device. This property will be populated from online settings when created with OfflineMapTask.createDefaultDownloadPreplannedOfflineMapParameters(PreplannedMapArea).

Link copied to clipboard

Describes how the offline map will obtain feature updates from the online service. The preplanned workflow offers three modes for updating the feature data in your offline map: