SDKOptions class

SDKOptions provide an alternative way to set or update the HERE SDK credentials and other parameters at runtime to initialize the SDKNativeEngine.

Constructors

SDKOptions.withAuthenticationMode(AuthenticationMode authenticationMode)
Constructs a SDKOptions from authentication mode.
factory

Properties

actionOnCacheLock ↔ SDKOptionsActionOnCacheLock
Specifies action to perform when cache folder is locked by another process. Default value is SDKOptionsActionOnCacheLock.waitLockingAppFinish.
getter/setter pair
authenticationMode ↔ AuthenticationMode
Encapsulates Authentication method and parameters.
getter/setter pair
autoUpdateOfOnlineCache ↔ bool
Parameter to enable automatic cache updates.
getter/setter pair
billingTag ↔ String?
Internal to HERE SDK. DO NOT USE THIS YET.
getter/setter pair
cachePath ↔ String
Path to be used for caching purposes. It should be a path to the desired location where the application has read/write permissions. The path can be on internal or external storage. By default, this returns an empty string. Setting a new string, will overwrite the internally used default paths:
getter/setter pair
cacheSizeInBytes ↔ int
Desired upper bound of application size in bytes. When cached data exceeds cache_size, least recently used data will be removed. Default value 256MB
getter/setter pair
catalogConfigurations ↔ List<CatalogConfiguration>
This field specifies how the SDKNativeEngine should access, use and store data for different catalogs. 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 further information about catalogs and related concepts see CatalogConfiguration
getter/setter pair
customEngineOptions ↔ Map<EngineBaseURL, EngineOptions>
Set custom options for SDK Engines. This includes:
getter/setter pair
customOptions ↔ Metadata?
Options that define custom behavior for the HERE SDK. These settings allow fine-tuning of internal thread pools and resource management for advanced use cases. These options are intended for internal usage only and should not be modified unless instructed by HERE support.
getter/setter pair
dataPath ↔ String
Path used for storing application internal data, such as the offline search index and other essential data required for proper functionality.
getter/setter pair
hashCode → int
The hash code for this object.
no setter
layerConfiguration ↔ LayerConfiguration
Defines a list of data features that can be enabled / disabled. Once set to SDKOptions when a new HERE SDK is constructed, it will affect the map cache and offline maps. When disabling certain features, less data will be prefetched when the map is rendered. Map data that was already cached will not be removed until the least recently used strategy (LRU) applies. That means you cannot remove any content from the map cache by updating the LayerConfiguration. However, for new map data, it will be applied. For offline maps, this LayerConfiguration can reduce the download size of all regions. Note that the LayerConfiguration is applied globally to all regions that will be downloaded in the future. It will not affect already downloaded regions. Updating a region will also not update the LayerConfiguration. Only the LayerConfiguration will be used that was set globally when a region was downloaded for the first time. If you want to update the LayerConfiguration for an already downloaded region, please delete the region and download it again.
getter/setter pair
lowMemoryMode ↔ bool
If an application runs in a memory-constrained environment, enable this option to reduce the HERE SDK's memory footprint. When set to true configures internal memory caches to consume less memory. Reduction in cache sizes also reduces performance of the HERE SDK. In order to release memory occupied by internal caches see SDKNativeEngine.purgeMemoryCaches.
getter/setter pair
networkSettings ↔ NetworkSettings
Network settings to use at the start. Some of those settings can be changed later.
getter/setter pair
offlineMode ↔ bool
Sets offline mode for the HERE SDK. Defaults to false. When enabled, this prevents the HERE SDK from initiating any online connection from starting. The mode can be disabled or enabled again at any time via SDKNativeEngine.isOfflineMode.
getter/setter pair
persistentMapStoragePath ↔ String
Path to store persistent map data. This should be the a path to the desired location for which the application has read/write permissions. The path can be on internal or external storage. By default, this returns an empty string. Setting a new string, will overwrite the internally used default paths:
getter/setter pair
politicalView ↔ String
Geopolitical view of a country, defined as a three letter country code by ISO 3166-1 alpha-3. Each disputed territory has an international and an alternative geopolitical view. When set, the map view will show all country boundaries according to the geopolitical view of the country that has been set.
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
scope ↔ String
Optional project ID to set the project scope of the login session. Not used if empty. see also Manage Projects and IAM Concepts
getter/setter pair

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.