Manage Downloads

Use the following scripts to control routing data and map tile download tasks for a region:

To pause a download that supports pausing:

1
try await NBNavigation.pauseRegionDownload(regionId: regionId)

To resume a download:

1
try await NBNavigation.resumeRegionDownload(regionId: regionId)

To cancel (stop) a download:

1
try await NBNavigation.cancelRegionDownload(regionId: regionId)

To delete routing and the map data for a region:

1
try await NBNavigation.deleteRegionAllData(regionId: regionId)

Operation	Effect	Deletes completed data
pause	Pauses downloads that support pausing	No
resume	Continues paused or resumable downloads	No
cancel	Cancels or stops the queued or running tasks	Does not guarantee deletion of existing complete packages
delete	Deletes local routing and map data for the region	Yes

pauseRegionDownload and resumeRegionDownload act on both routing and map tasks but return the routing-side result.

Use pauseRegionWithDetails and resumeRegionWithDetails to inspect both subtask results.

Use manageOfflineRegion to control only one dataset.

Non-transactional Behavior

cancel cancels routing work before map work, and delete removes routing data before map data. If the second step fails, the first step is not rolled back. After the operation, read progress and installed packages again and allow the user to retry the failed subtask.