Skip To Content ArcGIS for Developers Sign In Dashboard

ItemResourceCache Class

class Esri::ArcGISRuntime::ItemResourceCache

Contains information on offline resources, typically associated with a custom style for an ArcGISVectorTiledLayer. More...

Header: #include <ItemResourceCache>
Since: Esri::ArcGISRuntime 100.2
Inherits: Esri::ArcGISRuntime::Object and Esri::ArcGISRuntime::Loadable

This class was introduced in Esri::ArcGISRuntime 100.2.

Public Functions

ItemResourceCache(const QString &path, QObject *parent = nullptr)
virtual ~ItemResourceCache() override
Esri::ArcGISRuntime::LocalItem *item() const
QString path() const

Reimplemented Public Functions

virtual void cancelLoad() override
virtual void load() override
virtual Esri::ArcGISRuntime::Error loadError() const override
virtual Esri::ArcGISRuntime::LoadStatus loadStatus() const override
virtual void retryLoad() override

Signals

void doneLoading(Esri::ArcGISRuntime::Error loadError)
void loadStatusChanged(Esri::ArcGISRuntime::LoadStatus loadStatus)

Detailed Description

For example, a vector tile layer has style resources such as fonts and sprites.

Member Function Documentation

ItemResourceCache::ItemResourceCache(const QString &path, QObject *parent = nullptr)

Constructor that takes a path to the item resource cache, and an optional parent object.

[signal] void ItemResourceCache::doneLoading(Esri::ArcGISRuntime::Error loadError)

Signal emitted when this object is done loading.

  • loadError - Details about any error that may have occurred.

If there is a load error, it will also be emitted on the errorOccurred signal.

See also Loadable and Object.

[signal] void ItemResourceCache::loadStatusChanged(Esri::ArcGISRuntime::LoadStatus loadStatus)

loadStatus See Loadable.

[override virtual] ItemResourceCache::~ItemResourceCache()

Destructor

[override virtual] void ItemResourceCache::cancelLoad()

Reimplements: Loadable::cancelLoad().

See Loadable.

Esri::ArcGISRuntime::LocalItem *ItemResourceCache::item() const

Returns the local item containing this item resource cache's thumbnail and metadata.

This property can be a nullptr if the LocalItem is not present within the ItemResourceCache directory. If the ItemResourceCache was taken offline using ExportVectorTilesTask or OfflineMapTask, the LocalItem will be populated from the online PortalItem. If the ItemResourceCache was created inside a MobileMapPackage authored from ArcGIS Pro, then this property will return a nullptr.

[override virtual] void ItemResourceCache::load()

Reimplements: Loadable::load().

See Loadable.

[override virtual] Esri::ArcGISRuntime::Error ItemResourceCache::loadError() const

Reimplements: Loadable::loadError() const.

See Loadable.

[override virtual] Esri::ArcGISRuntime::LoadStatus ItemResourceCache::loadStatus() const

Reimplements: Loadable::loadStatus() const.

See Loadable.

QString ItemResourceCache::path() const

Returns the path to the on-disk location containing this item resource cache.

The path can be a directory on disk that contains the ItemResourceCache. Alternatively, if the ItemResourceCache was loaded from a package file, such as a MobileMapPackage, the path is to the package.

[override virtual] void ItemResourceCache::retryLoad()

Reimplements: Loadable::retryLoad().

See Loadable.


Feedback on this topic?