PreplannedMapArea QML Type

Returns the area of interest bounding the preplanned map area (read-only).

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

Returns an immutable list of portal items fetched by a contentItems operation (read-only).

Obtain this property after the contentItemsStatusChanged signal emits, and the contentItemsStatus is Enums.TaskStatusCompleted.

This property was introduced in Esri.ArcGISRuntime 100.3.

Returns the status of the contentItems asynchronous operation (read-only).

Check this status when the contentItemsStatusChanged signal emits, to determine if the operation is complete, in progress, or has errored.

This property was introduced in Esri.ArcGISRuntime 100.3.

See also Enums.TaskStatus.

Returns the load error (read-only).

Note: load errors are also reported on the error property and emit the errorChanged signal.

See also Loadable and Object.

Returns the load status (read-only).

See also Loadable and Enums.LoadStatus.

Describes the publishing status of the online map area (read-only).

This property allows you to check if an online PreplannedMapArea is in a Enums.PreplannedPackagingStatusComplete state and ready to be downloaded.

There are four possible values:

• Enums.PreplannedPackagingStatusUnknown indicates that the metadata for the map area has not been fetched. This will be the value when the map area is Enums.LoadStatusNotLoaded.
• Enums.PreplannedPackagingStatusProcessing indicates that the online map area is not yet ready to be downloaded. The packages required for the map area have not been created yet.
• Enums.PreplannedPackagingStatusFailed 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.
• Enums.PreplannedPackagingStatusComplete indicates the map area is ready for download and the data has been packaged.

If you attempt to download a PreplannedMapArea that is not Enums.PreplannedPackagingStatusComplete the DownloadPreplannedOfflineMapJob will fail with Error::code 7022.

If you attempt to create a set of DownloadPreplannedOfflineMapParameters by calling OfflineMapTask::createDefaultDownloadPreplannedOfflineMapParameters from a PreplannedMapArea that is not Enums.PreplannedPackagingStatusComplete, the operation will also fail with Error::code 7022.

If the packaging status is Enums.PreplannedPackagingStatusProcessing you can check it again following these steps:

• 1. Create a new PortalItem instance using the PortalItem::url in the PreplannedMapArea::portalItem.
• 2. Create a new PreplannedMapArea using the portal item.
• 3. Load the PreplannedMapArea and check PreplannedMapArea::packagingStatus.

This property was introduced in Esri.ArcGISRuntime 100.9.

Returns the portal item that this preplanned map area was created from.

Describes what methods for obtaining updates are supported for this preplanned map area (read-only).

This property will return an empty OfflineMapUpdateCapabilities until loaded.

This property was introduced in Esri.ArcGISRuntime 100.6.

Emitted when the contentItemsStatus property changes.

Note: The corresponding handler is onContentItemsStatusChanged.

This signal was introduced in Esri.ArcGISRuntime 100.3.

Emitted when the loadError property changes.

Note: The corresponding handler is onLoadErrorChanged.

See also Loadable and Object.

Emitted when the loadStatus property changes.

Note: The corresponding handler is onLoadStatusChanged.

See also Loadable.

Emitted when the packagingStatus property changes.

Note: The corresponding handler is onPackagingStatusChanged.

This signal was introduced in Esri.ArcGISRuntime 100.9.

Emitted when the portalItem property changes.

Note: The corresponding handler is onPortalItemChanged.

See also PortalItem.

Emitted when the updateCapabilities property changes.

Note: The corresponding handler is onUpdateCapabilitiesChanged.

This signal was introduced in Esri.ArcGISRuntime 100.6.

See also Loadable.

Cancel the task with the ID taskId.

Returns false if the task cannot be cancelled or there is no task with the specified id taskId.

This method was introduced in Esri.ArcGISRuntime 100.3.

See also Cancelable.

Starts a task that fetches the content items for this preplanned map area.

This method populates an ImmutablePortalItemListModel with the content items for this preplanned area.

The list model is returned to the app through the property contentItemsResult. Monitor the signal contentItemsStatusChanged. When the status changes to Enums.TaskStatusCompleted, the contentItemsResult property is populated. The results of this operation are cached, so the same portal item instances will be returned with each subsequent call of this method.

Returns a task ID that can be used to cancel the contentItems task.

This method was introduced in Esri.ArcGISRuntime 100.3.

See also Loadable.

See also Loadable.