CatalogConfiguration class
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 the Navigate license.
Constructors
- CatalogConfiguration(DesiredCatalog catalog)
Properties
- allowDownload ↔ bool
-
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 (see CatalogConfiguration.cacheExpirationPeriod).
Defaults to
true.getter/setter pair - cacheExpirationPeriod ↔ Duration?
-
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.
getter/setter pair
- catalog ↔ DesiredCatalog
-
The identifier for the desired catalog to be accessed on the HERE platform.
See DesiredCatalog.
getter/setter pair
- hashCode → int
-
The hash code for this object.
no setter
- patchHrn ↔ String?
-
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 is
null, then incremental updates are disabled.getter/setter pair - runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool - The equality operator.
Static Methods
-
getDefault(
CatalogType catalogType) → CatalogConfiguration - Gets the default catalog configuration for the specified catalog type.