Show / Hide Table of Contents

Method GenerateOfflineMap

GenerateOfflineMap(GenerateOfflineMapParameters, String)

Returns a job that is used to generate an offline map using the specified parameters.

Declaration
public GenerateOfflineMapJob GenerateOfflineMap(GenerateOfflineMapParameters parameters, string downloadDirectoryPath)
Parameters
Type Name Description
GenerateOfflineMapParameters parameters

GenerateOfflineMapParameters specifying how to take a map offline. For example, specify the area of interest, min and max scale, and layer attachment options.

System.String 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".

Returns
Type Description
GenerateOfflineMapJob

A GenerateOfflineMapJob to generate an offline map.

Remarks

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

Applies to

Platforms and versions
TargetVersions
.NET Standard 2.0100.3 - 200.7
.NET100.13 - 200.7
.NET Windows100.13 - 200.7
.NET Android200.0 - 200.7
.NET iOS200.0 - 200.7
.NET Framework100.1 - 200.7
Xamarin.Android100.1 - 100.15
Xamarin.iOS100.1 - 100.15
UWP100.1 - 200.7

GenerateOfflineMap(GenerateOfflineMapParameters, String, GenerateOfflineMapParameterOverrides)

Returns a job that is used to generate an offline map using the specified parameters and overrides.

Declaration
public GenerateOfflineMapJob GenerateOfflineMap(GenerateOfflineMapParameters parameters, string downloadDirectoryPath, GenerateOfflineMapParameterOverrides overrides)
Parameters
Type Name Description
GenerateOfflineMapParameters parameters

GenerateOfflineMapParameters specify how to take a map offline. For example, specify the area of interest, min and max scale, layer attachment options.

System.String 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".

GenerateOfflineMapParameterOverrides overrides

The overrides to the parameters.

Returns
Type Description
GenerateOfflineMapJob

A GenerateOfflineMapJob to generate an offline map.

Remarks

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.

The GenerateOfflineMapParameterOverrides allows more control over the extracted data.

To create an instance GenerateOfflineMapParameterOverrides use CreateGenerateOfflineMapParameterOverridesAsync(GenerateOfflineMapParameters).

Some properties on GenerateOfflineMapParameters will be ignored when using GenerateOfflineMapParameterOverrides and replaced with equivalent properties for each service. The overridden properties are:

  • IncludeBasemap
  • ReturnLayerAttachmentOption
  • AttachmentSyncDirection
  • ReturnSchemaOnlyForEditableLayers
  • IsDefinitionExpressionFilterEnabled
  • OnlineOnlyServicesOption

Applies to

Platforms and versions
TargetVersions
.NET Standard 2.0100.4 - 200.7
.NET100.13 - 200.7
.NET Windows100.13 - 200.7
.NET Android200.0 - 200.7
.NET iOS200.0 - 200.7
.NET Framework100.4 - 200.7
Xamarin.Android100.4 - 100.15
Xamarin.iOS100.4 - 100.15
UWP100.4 - 200.7
In This Article
Back to top Copyright © 2022 Esri.