CatalogConfiguration Structure Reference
- Last UpdatedMay 13, 2025
- 2 minute read
public struct CatalogConfiguration : Hashable
Using this class you can configure in the SDKOptions
,
how the SDKNativeEngine
should access, use and store the data for the desired catalog.
Using this class, you can access default catalogs on the HERE platform and also custom catalogs such as for self-hosted or BYOD (bring your own data) use cases.
For information on how the user can identify a catalog on the HERE platform, see DesiredCatalog
For further information about catalogs and related concepts see CatalogIdentifier
.
Note: This API is only applicable for enhanced editions such as the Navigate Edition.
-
The identifier for the desired catalog to be accessed on the HERE platform. See
DesiredCatalog
.Declaration
Swift
public var catalog: DesiredCatalog
-
Some catalogs may have additional modifications to their data contained in an entirely separate catalog, called the patch catalog. This field indicates the HERE Resource Name (HRN) for the patch catalog. When this field is present, the catalog’s data as referenced by
CatalogConfiguration.catalog
is merged with data from the patch catalog. If this field isnil
, then incremental updates are disabled.Declaration
Swift
public var patchHrn: String?
-
Expiration time in seconds for how long the catalog data is retained in the map cache before it is removed. Cache path is specified by
SDKOptions.cachePath
. If not set, the cache will be deleted on a Least Recently Used (LRU) basis.Declaration
Swift
public var cacheExpirationPeriod: TimeInterval?
-
A flag to indicate if the data for this catalog is allowed to be stored in persistent storage for use with offline maps. The storage path is specified in
SDKOptions.persistentMapStoragePath
. If set to false, the data is not stored in persistent storage and is only retained in the cache for a limited time (seeCatalogConfiguration.cacheExpirationPeriod
). Defaults to true.Declaration
Swift
public var allowDownload: Bool
-
Creates a new instance.
Declaration
Swift
public init(catalog: DesiredCatalog, patchHrn: String? = nil, cacheExpirationPeriod: TimeInterval? = nil, allowDownload: Bool = true)
-
Gets the default catalog configuration for the specified catalog type. It uses the catalog version that was the latest at the time when the HERE SDK was built.
Declaration
Swift
public static func getDefault(catalogType: CatalogType) -> CatalogConfiguration
Parameters
catalogType
Catalog type
Return Value
Instance of
CatalogConfiguration
.