PreplannedMapArea

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.downloadPreplannedOfflineMap(DownloadPreplannedOfflineMapParameters, String) method on the OfflineMapTask.

Constructors

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

open override fun cancelLoad()

Cancels loading metadata for the Loadable object.

open suspend override fun load(): Result<Unit>

Loads the metadata for the object.

open suspend override fun retryLoad(): Result<Unit>

Loads or retries loading metadata for the object.

open override val loadStatus: StateFlow<LoadStatus>

The load status.

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.