Represents a single preplanned offline map area. Offline map areas are specific work areas or major incident areas that are defined by an online map author ahead of time. Each online map can contain a number of offline map areas. These can be provided in a list by the OfflineMapTask.getPreplannedMapAreas() method. Each preplanned map area uses map content that is stored online. Download this map content by running a DownloadPreplannedOfflineMapJob. Create this job by passing the preplanned map area to the OfflineMapTask.createDownloadPreplannedOfflineMapJob(DownloadPreplannedOfflineMapParameters, String) method on the OfflineMapTask.

To successfully load a PreplannedMapArea the PreplannedMapArea.packagingStatus must be PreplannedPackagingStatus.Complete.




Link copied to clipboard
constructor(portalItem: PortalItem)

Create an offline map area instance with a portal item that is of type map area.


Link copied to clipboard

The area of interest bounding the offline map area. The area of interest is returned as a Geometry, which can be either an Envelope or a Polygon depending on how the online map area was created.

Link copied to clipboard
val packageItems: StateFlow<List<PortalItem>>

Portal items for packages related to this preplanned map area. When the offline map area has successfully loaded, this collection contains the portal items for the packages (tile packages or geodatabases) holding the offline data for the map area.

Link copied to clipboard

Describes the packaging status of the online map area. This property allows you to check whether an online PreplannedMapArea is in a PreplannedPackagingStatus.Complete state and ready to be downloaded.

Link copied to clipboard

The portal item that this offline map area was created from.

Link copied to clipboard

Describes the methods for obtaining updates that are supported for this offline map area. There are two approaches for updating the features in a preplanned offline map area:

Inherited properties

Link copied to clipboard
open override val loadStatus: StateFlow<LoadStatus>

The load status.

Inherited functions

Link copied to clipboard
open override fun cancelLoad()

Cancels loading metadata for the Loadable object.

Link copied to clipboard
open suspend override fun load(): Result<Unit>

Loads the metadata for the object.

Link copied to clipboard
open suspend override fun retryLoad(): Result<Unit>

Loads or retries loading metadata for the object.