ArcGIS Runtime SDK for iOS: AGSDownloadPreplannedOfflineMapParameters Class Reference
ArcGIS Runtime SDK for iOS  100.12
AGSDownloadPreplannedOfflineMapParameters Class Reference

Description

Parameters used with AGSOfflineMapTask to take a preplanned map area offline.

Instances of this class represent parameters that are used with downloadPreplannedOfflineMapJobWithArea:downloadDirectory: (AGSOfflineMapTask(AGSDeprecated)) to create a job that can take a preplanned map area offline.

Since
100.4
Inheritance diagram for AGSDownloadPreplannedOfflineMapParameters:
AGSObject

Instance Methods

(instancetype) - initWithPreplannedMapArea:
 

Class Methods

(instancetype) + preplannedOfflineMapParameters
 
(instancetype) + preplannedOfflineMapParametersWithPreplannedOfflineMapArea:
 

Properties

BOOL continueOnErrors
 
BOOL includeBasemap
 
AGSPreplannedMapAreapreplannedMapArea
 
NSURL * referenceBasemapDirectory
 
NSString * referenceBasemapFilename
 
AGSPreplannedUpdateMode updateMode
 

Method Documentation

◆ initWithPreplannedMapArea:

- (instancetype) initWithPreplannedMapArea: (AGSPreplannedMapArea *)  preplannedMapArea

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

Parameters
preplannedMapAreapreplanned map area representing area to be downloaded for offline use.
Since
100.4

◆ preplannedOfflineMapParameters

+ (instancetype) preplannedOfflineMapParameters

Creates a download preplanned offline map parameters object.

Returns
A new download preplanned offline map parameters object.
Since
100.4

◆ preplannedOfflineMapParametersWithPreplannedOfflineMapArea:

+ (instancetype) preplannedOfflineMapParametersWithPreplannedOfflineMapArea: (AGSPreplannedMapArea *)  preplannedMapArea

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

Parameters
preplannedMapAreaA preplanned map area representing area to be downloaded for offline use.
Returns
A new download preplanned offline map parameters object.
Since
100.4

Property Documentation

◆ continueOnErrors

- (BOOL) continueOnErrors
readwritenonatomicassign

Indicates whether or not the job should continue running in the event of a failure to take a layer offline. If this property is YES, 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 NO, 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. Default value is YES.

Since
100.4

◆ includeBasemap

- (BOOL) includeBasemap
readwritenonatomicassign

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 NO.

After loading the offline map, your application can programmatically insert a basemap into the map. Note that a programmatically inserted basemap will not be persisted in the map.

If you want a basemap in the offline map, then set this property to YES. You can choose to either:

The default value is YES.

Since
100.4

◆ preplannedMapArea

- (AGSPreplannedMapArea*) preplannedMapArea
readwritenonatomicstrong

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

Since
100.4

◆ referenceBasemapDirectory

- (NSURL*) referenceBasemapDirectory
readwritenonatomicstrong

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 the AGSDownloadPreplannedOfflineMapParameters::referenceBasemapFilename property is defined.

This property supports any directory specified as either:

If the directory does not exist, or does not contain the specified basemap, the AGSDownloadPreplannedOfflineMapJob will fail.

Note that the mobile map package will store either a relative or absolute path to the reference basemap file so that it can be opened in the future.

A relative path typically begins with "./" to denote the parent directory of the resulting mobile map package or "../" to move up one directory. The parent directory of the mobile map package will be set when calling generateOfflineMapJobWithParameters:downloadDirectory: (AGSOfflineMapTask).

For example, to download a mobile map package to "[my root path]/my_offline_maps/my_mobile_map_package", which uses a reference basemap in "[my root path]/other_maps/my_basemap.tpk", you would set the relative path as follows:

Note that this property is ignored if the AGSDownloadPreplannedOfflineMapParameters::includeBasemap property is NO.

Since
100.5

◆ referenceBasemapFilename

- (NSString*) referenceBasemapFilename
readwritenonatomiccopy

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 AGSOfflineSettings) 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 AGSOfflineMapTask::defaultDownloadPreplannedOfflineMapParametersWithArea:completion. If you wish to use the specified local basemap rather than downloading, you must also set AGSDownloadPreplannedOfflineMapParameters::referenceBasemapDirectory. If the directory does not exist, or does not contain the specified basemap filename, the AGSDownloadPreplannedOfflineMapJob will fail. The spatial reference of the reference basemap is used for the offline map when it is different to the online map's spatial reference. Note that this property is ignored if AGSDownloadPreplannedOfflineMapParameters::includeBasemap is NO.

Since
100.5

◆ updateMode

- (AGSPreplannedUpdateMode) updateMode
readwritenonatomicassign

Describes how the offline map will obtain feature updates from the online service.

The preplanned workflow offers two modes for updating the feature data in your offline map:

  • Sync feature changes directly with online feature services
  • Download a set of scheduled updates (geodatabase delta files which are cached on the server) from the online map area

To register your mobile geodatabases for syncing with online feature services, set this property to AGSPreplannedUpdateModeSyncWithFeatureServices. Syncing allows you to upload as well as download changes, so this approach should be used when you need to edit your data. As you sync changes directly with the back-end services, you will receive the most up-to-date feature data available. This is the default mode if you construct the AGSDownloadPreplannedOfflineMapParameters object.

To download a set of cached updates (delta files) from the online map area, set this property to AGSPreplannedUpdateModeDownloadScheduledUpdates. With this approach, updates are generated whenever the online map area is refreshed - for example according to its update schedule. Updates are prepared once and cached for download by all users of the offline map area. Sharing a single set of cached updates, rather than performing individual sync operations, reduces the load on the back-end services - this makes this approach scalable for large deployments. As updates are only downloaded, this approach can only be used with read-only workflows. The updates also reflect a snapshot of the feature data at the time the online map area was refreshed - rather than the most up-to-date information. The web map author must configure the online map to store cached updates for this approach.

If you use this AGSDownloadPreplannedOfflineMapParameters::updateMode property with a web map which does not support scheduled updates, the resultant AGSDownloadPreplannedOfflineMapJob object will fail with an error NSError::code of AGSErrorCodeMappingScheduledUpdatesNotSupported.

Since
100.6