Class OfflineManager

A utility object that maintains the state of offline map areas and their storage on the device.

Inheritance

OfflineManager

Namespace: Esri.ArcGISRuntime.Toolkit

Assembly: Esri.ArcGISRuntime.Toolkit.Maui.dll

Syntax

public sealed class OfflineManager

Remarks

This component provides high-level APIs to manage offline map areas and access their data. This component manages offline jobs and it utilizes the JobManager in order to facilitate jobs continuing to run while the app is backgrounded.

Features
The component supports both ahead-of-time(preplanned) and on-demand workflows for offline mapping. It allows you to:

Observe job status.
Access map info for web maps that have saved map areas via OfflineMapInfos.
Remove offline map areas from the device.
Run download jobs while the app is in the background.
Get notified when the jobs complete via the JobCompleted event.

The component is useful both for building custom UI with the provided APIs, and for supporting workflows that require retrieving offline map areas information from the device. By using the OfflineManager, you can create an OfflineMapAreasView and setting the OfflineMapInfo property. You can get the list of previously stored map infos from the OfflineMapInfos collection.

Behavior
The offline manager is not instantiable; use the shared instance. Configure the offline manager through the Configuration property before starting jobs.

note

The OfflineManager can be used independently of any UI components, making it suitable for automated workflows or custom implementations.

Properties

Name	Description
Configuration	Gets or sets the configuration for this offline manager.
Jobs	Gets the jobs currently managed by this instance.
OfflineMapInfos	Gets the portal item information for web maps that have downloaded map areas.
Shared	Gets the shared offline manager instance.

Methods

Name	Description
RemoveAllDownloads()	Removes all downloads for all offline maps.
RemoveDownloads(OfflineMapInfo)	Removes any downloaded map areas for a particular map.
StartJobAsync(DownloadPreplannedOfflineMapJob, PortalItem, string)	Starts a job that will be managed by this instance.
StartJobAsync(GenerateOfflineMapJob, PortalItem, string)	Starts a job that will be managed by this instance.
StartJobAsync(OfflineMapSyncJob, PortalItem, string)	Starts a job that will be managed by this instance.

Events

Name	Description
JobCompleted	Occurs when a managed job completes.