OfflineCapability Class

OfflineCapability

class Esri::ArcGISRuntime::OfflineCapability

Describes whether an offline-enabled web map's layer or table can be included in an offline map. More...

Header:	`#include <OfflineCapability.h>`
Since:	Esri::ArcGISRuntime 100.1

List of all members, including inherited members

Public Functions

	OfflineCapability(const Esri::ArcGISRuntime::OfflineCapability &other)
	OfflineCapability(Esri::ArcGISRuntime::OfflineCapability &&other)
	~OfflineCapability()
Esri::ArcGISRuntime::Error	error() const
bool	isEmpty() const
`(since Esri::ArcGISRuntime 100.9)` bool	isRemainsOnline() const
bool	isSupportsOffline() const
Esri::ArcGISRuntime::OfflineCapability &	operator=(Esri::ArcGISRuntime::OfflineCapability &&other)
Esri::ArcGISRuntime::OfflineCapability &	operator=(const Esri::ArcGISRuntime::OfflineCapability &other)

Detailed Description

You can confirm which layers or tables, in an offline-enabled web map, can be taken offline by creating an OfflineMapTask from the web map, calling OfflineMapTask::offlineMapCapabilitiesAsync(const Esri::ArcGISRuntime::GenerateOfflineMapParameters&), and examining the resulting OfflineMapCapabilities::layerCapabilities and OfflineMapCapabilities::tableCapabilities dictionaries.

If a layer or table can be taken offline then its isSupportsOffline value is true.

Member Function Documentation

OfflineCapability::OfflineCapability(const Esri::ArcGISRuntime::OfflineCapability &other)

Copy constructor from other OfflineCapability.

`[noexcept]` OfflineCapability::OfflineCapability(Esri::ArcGISRuntime::OfflineCapability &&other)

Move constructor from other OfflineCapability.

`[noexcept]` OfflineCapability::~OfflineCapability()

Destructor.

Esri::ArcGISRuntime::Error OfflineCapability::error() const

Returns the associated error if the layer or table could not be included in the offline map. Otherwise returns empty.

bool OfflineCapability::isEmpty() const

Returns whether this object is empty.

`[since Esri::ArcGISRuntime 100.9]` bool OfflineCapability::isRemainsOnline() const

Returns true if this online only layer or table will be referenced from an offline map, false otherwise.

If this value is true, the layer or table will be available in the offline map when network connectivity is present.

If GenerateOfflineMapParameters::onlineOnlyServicesOption is set to OnlineOnlyServicesOption::Exclude, this property will always be false. If GenerateOfflineMapParameters::onlineOnlyServicesOption is set to OnlineOnlyServicesOption::Include, this property will be true for layers and tables that cannot be taken offline.

This function was introduced in Esri::ArcGISRuntime 100.9.

bool OfflineCapability::isSupportsOffline() const

Returns true if this layer or table supports being taken offline, false otherwise.

If this property is false and the GenerateOfflineMapParameters::onlineOnlyServicesOption is set to OnlineOnlyServicesOption::Include, the OfflineCapability::isRemainsOnline property will indicate that the layer or table will remain online and be referenced by the offline map.

`[noexcept]` Esri::ArcGISRuntime::OfflineCapability &OfflineCapability::operator=(Esri::ArcGISRuntime::OfflineCapability &&other)

Move operator from other OfflineCapability.

Esri::ArcGISRuntime::OfflineCapability &OfflineCapability::operator=(const Esri::ArcGISRuntime::OfflineCapability &other)

Assignment operator from other OfflineCapability.