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

Description

Represents an individual preplanned map area.

Instances of this class represent an individual preplanned map area.

Preplanned map areas are specific work areas or major incident areas that are defined by a map author. Each map can contain a number of preplaned map areas. These can be retrieved using getPreplannedMapAreasWithCompletion: (AGSOfflineMapTask)

Each preplanned map area contains map content that is packaged and staged for easy download that speeds up the process of taking a map offline. Preplanned map areas can be downloaded to create an offline map using the downloadPreplannedOfflineMapJobWithArea:downloadDirectory: (AGSOfflineMapTask(AGSDeprecated)).

To successfully load an AGSPreplannedMapArea, the AGSPreplannedMapArea::packagingStatus must be AGSPreplannedPackagingStatusComplete.

Since
100.2
Inheritance diagram for AGSPreplannedMapArea:
AGSLoadableBase AGSObject <AGSLoadable>

Instance Methods

(void) - cancelLoad
 
(void) - doCancelLoading
 
(void) - doStartLoading:
 
(id< AGSCancelable >) - getContentItemsWithCompletion:
 
(instancetype) - initWithPortalItem:
 
(void) - loadDidFinishWithError:
 
(void) - loadWithCompletion:
 
(void) - onLoadStatusChanged
 
(void) - retryLoadWithCompletion:
 

Class Methods

(instancetype) + preplannedMapAreaWithPortalItem:
 

Properties

AGSGeometryareaOfInterest
 
NSError * loadError
 
AGSLoadStatus loadStatus
 
AGSPreplannedPackagingStatus packagingStatus
 
AGSPortalItemportalItem
 
AGSOfflineMapUpdateCapabilitiesupdateCapabilities
 

Method Documentation

◆ cancelLoad

- (void) cancelLoad
requiredinherited

Cancels loading if it is in progress, otherwise it does nothing. This should be called carefully because other objects could be waiting for loadWithCompletion: or retryLoadWithCompletion: to complete and this will call them all back with the error of NSUserCancelledError

Since
100

◆ doCancelLoading

- (void) doCancelLoading

Never call this method directly. The framework calls this method on a background thread when cancelLoad (AGSLoadable-p) is called. It is meant to be overriden by subclasses. Subclasses should override this method to cancel loading their data and call loadDidFinishWithError: (AGSLoadableBase(ForSubclassEyesOnly)) at the end passing in an error representing NSUserCancelledError.

Since
100

Provided by category AGSLoadableBase(ForSubclassEyesOnly).

◆ doStartLoading:

- (void) doStartLoading: (BOOL)  retrying

Never call this method directly. The framework calls this method on a background thread when loadWithCompletion: (AGSLoadable-p) or retryLoadWithCompletion: (AGSLoadable-p) is called. It is meant to be overriden by subclasses. Subclasses should override this method to load their data and call loadDidFinishWithError: (AGSLoadableBase(ForSubclassEyesOnly)) upon completion, passing in the error if any.

Parameters
retryingflag that is true if this method was called from retryLoadWithCompletion: (AGSLoadable-p).
Since
100

Provided by category AGSLoadableBase(ForSubclassEyesOnly).

◆ getContentItemsWithCompletion:

- (id<AGSCancelable>) getContentItemsWithCompletion: (void(^)(NSArray< AGSPortalItem * > *__nullable contentItems, NSError *__nullable error))  completion

Retrieves a list of items representing map content for this preplanned map area, if there are any. The content items will be cached so the same instances will be returned with each subsequent call of this method.

Parameters
completionA block that is invoked with the results if the operation succeeds, or an error if it fails.
Returns
An operation that can be canceled.
Since
100.3

◆ initWithPortalItem:

- (instancetype) initWithPortalItem: (AGSPortalItem *)  portalItem

Creates a preplanned map area the provided portal item representing a map area.

Parameters
portalItemA portal item representing a map area.
Since
100.2

◆ loadDidFinishWithError:

- (void) loadDidFinishWithError: (nullable NSError *)  error

Only subclasses should call this method in doStartLoading: (AGSLoadableBase(ForSubclassEyesOnly)) and doCancelLoading (AGSLoadableBase(ForSubclassEyesOnly)) when done loading or failed to load.

Since
100

Provided by category AGSLoadableBase(ForSubclassEyesOnly).

◆ loadWithCompletion:

- (void) loadWithCompletion: (nullable void(^)(NSError *__nullable error))  completion
requiredinherited

Loads data for the object asynchronously. The completion block is invoked upon completion.

You can call this method any number of times, however only one attempt is made to load the data. If it is already loading, it will just continue to load (i.e. not force a reload). If it has already loaded successfully, the completion block will be invoked right away. If it has already failed to load, the completion block will be invoked right away with error previously encountered. This method supports multiple callers and will call them all back on completion. However, each caller's completion block will be invoked once and only once.

Parameters
completionblock that is invoked when object loads successfully or fails to load. An error is passed to the block if the object fails to load.
Note
The completion block is always invoked on the main thread.
Since
100
See also
- cancelLoad to cancel loading
- retryLoadWithCompletion: to force reload

◆ onLoadStatusChanged

- (void) onLoadStatusChanged

Never call this method directly. The framework calls this method on a background thread when AGSLoadable::loadStatus changes is called. Subclasses can optionally implement this to know when their loading status has changed.

Since
100

Provided by category AGSLoadableBase(ForSubclassEyesOnly).

◆ preplannedMapAreaWithPortalItem:

+ (instancetype) preplannedMapAreaWithPortalItem: (AGSPortalItem *)  portalItem

Creates a preplanned map area the provided portal item representing a map area.

Parameters
portalItemA portal item representing a map area.
Returns
A new preplanned map area.
Since
100.2

◆ retryLoadWithCompletion:

- (void) retryLoadWithCompletion: (nullable void(^)(NSError *__nullable error))  completion
requiredinherited

Tries to reload when an object has failed to load. This method should be called judiciously. It should be called when:

  1. you didn't have network connectivity earlier when it failed and you want to retry now that you have connectivity
  2. the server was down earlier when it failed and you want to retry
  3. the request is taking too long and you want to cancel it and retry, in which case you will first call cancelLoad and then this method

If the data hasn't started loading, it will start loading. If it is already loading, it will just continue to load. If it has already loaded successfully, calls back right away. If it has already failed to load, tries again. This method supports multiple callers and will call them all back on completion. However, each caller's completion block will be invoked once and only once.

Parameters
completionblock that is invoked when object loads successfully or fails to load. An error is passed to the block if the object fails to load.
Note
The completion block is always invoked on the main thread.
Since
100

Property Documentation

◆ areaOfInterest

- (AGSGeometry*) areaOfInterest
readnonatomicstrong

Bounding box representing the region covered by this preplanned map area. The area of interest is returned as an AGSGeometry which can be either an AGSEnvelope or an AGSPolygon depending on how the online map area was created.

Since
100.2

◆ loadError

- (NSError*) loadError
readnonatomicstronginherited

The error that was encountered during the most recent load operation. Will be nil if the operation succeeded.

Since
100

◆ loadStatus

- (AGSLoadStatus) loadStatus
readrequirednonatomicassigninherited

Status of the load operation.

Since
100

◆ packagingStatus

- (AGSPreplannedPackagingStatus) packagingStatus
readnonatomicassign

Describes the packaging status of the online map area.

This property allows you to check whether an online AGSPreplannedMapArea is in an AGSPreplannedPackagingStatusComplete state and ready to be downloaded. If you attempt to load an AGSPreplannedMapArea that is not AGSPreplannedPackagingStatusComplete, the AGSPreplannedMapArea will fail to load with an error of AGSErrorCodeMappingPackagingNotComplete.

There are four possible values:

  • AGSPreplannedPackagingStatusComplete indicates the map area is ready for download and the data has been packaged.
  • AGSPreplannedPackagingStatusProcessing indicates that the online map area is not yet ready to be downloaded. The packages required for the map area have not been packaged yet. This status will be available after the AGSPreplannedMapArea fails to load.
  • AGSPreplannedPackagingStatusFailed indicates that an error was encountered while preparing the online map area or its packages. In this scenario, the map area cannot be downloaded until the web map author has resolved the errors. This status will be available after the AGSPreplannedMapArea fails to load.
  • AGSPreplannedPackagingStatusUnknown indicates that the metadata for the map area has not been fetched. This will be the value when the map area is AGSLoadStatusNotLoaded.

If the packaging status is AGSPreplannedPackagingStatusProcessing, you can check it again following these steps:

  1. Create a new AGSPortalItem instance using the AGSPortalItem::URL in the AGSPreplannedMapArea::portalItem.
  2. Create a new AGSPreplannedMapArea using the portal item initWithPortalItem:.
  3. Load the AGSPreplannedMapArea and check AGSPreplannedMapArea::packagingStatus.
    Since
    100.9

◆ portalItem

- (AGSPortalItem*) portalItem
readnonatomicstrong

Portal item representing a map area.

Since
100.2

◆ updateCapabilities

- (AGSOfflineMapUpdateCapabilities*) updateCapabilities
readnonatomicstrong

Describes what methods for obtaining updates are supported for this preplanned map area. This property will return null until the preplanned map area is loaded.

Since
100.6