SDKNativeEngine class abstract

Holds internal services and configurations needed by various HERE SDK modules.

You can initialize the HERE SDK in two ways:

  • Create a shared instance of the SDKNativeEngine with SDKNativeEngine.makeSharedInstance().
  • Create individual instances of the SDKNativeEngine via SDKNativeEngine(). Note that this does not automatically set a shared instance.

Constructors

SDKNativeEngine(SDKOptions options)
Makes a new instance of SDKNativeEngine using supplied options.
factory

Properties

hashCode → int
The hash code for this object.
no setterinherited
isOfflineMode ↔ bool
The offline mode. Sets offline mode for the HERE SDK to offline or online. Defaults to false, which means the HERE SDK uses an online connection. When enabled, this prevents the HERE SDK from initiating any online connection except for provided pass through features if set. See SDKNativeEngine.passThroughFeatures. Note that the flag does not cancel pending requests. The mode can be enabled or disabled at any time. In order to fully operate offline, the mode needs to be enabled via SDKOptions.offlineMode. Initialization of the HERE SDK itself does not require an internet connection. Returns true if the HERE SDK uses offline connection mode, otherwise returns false.
getter/setter pair
options → SDKOptions
Options used by this instance of SDKNativeEngine. Gets the options used by this instance of SDKNativeEngine.
no setter
passThroughFeatures ↔ Set<PassThroughFeature>?
The pass through features. Sets pass through features which are allowed to use online data when HERE SDK is in offline mode. Pass through features can be updated at any time. When offline mode is disabled, existing pass through features will be removed. These needs to be set again when you enable offline mode next time. By default, reporting of HERE SDK UsageStats will be enabled when at least one pass-through feature is set.
getter/setter pair
proxySettings ↔ ProxySettings?
Proxy settings of this SDK engine that will be used by HERE SDK network for all requests. Defaults to (null), which indicates proxy is not enabled. When setting proxy settings, they will immediately be applied and all the pending and fresh requests will use these settings. Pass (null) to indicate that proxy should be disabled. If proxy is necessary from the start then it's recommended to use NetworkSettings.proxySettings in SDKOptions.networkSettings.
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
sdkUsageStats → List<UsageStats>
Gets a list of usage statistics for all available HERE SDK features. UsageStats has cache and persistent storage. Reads from the persistent storage happen on SDKNativeEngine creation step. Writes to persistent storage happen by reaching internal limit (amount of upload bytes, by default is 50KB).
no setter

Methods

clearPersistentUsageStats() → void
Clear persistent storage for the HERE SDK UsageStats.
clearUsageStatsCache() → void
Clear cache for the HERE SDK UsageStats.
dispose() → Future<void>
Stops pending requests and closes open files and databases in main thread.
enableUsageStats(bool enabled) → void
Enable or disable UsageStats for the HERE SDK.
getDeviceId() → Future<String>
The unique identifier assigned to the device for this application.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
purgeMemoryCaches(SDKNativeEnginePurgeMemoryStrategy strategy) → void
Releases memory occupied by internal caches.
setAccessKeySecret(String accessKeySecret) → void
Overrides HERE SDK access key secret with new value.
setAccessScope(String scope) → void
Overrides the token scope of the HERE SDK with new value.
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Properties

parameterConfig ↔ ParameterConfiguration
Configuration for default values of parameters used in the HERE SDK. Note: This feature is in beta state and thus there can be bugs and unexpected behavior. Related APIs may change for new releases without a deprecation process. Gets the configuration for default values of parameters used in the HERE SDK.
getter/setter pair
sharedInstance ↔ SDKNativeEngine?
Shared instance of this SDK engine that can be accessed by any HERE SDK module as the default engine. This is automatically set as a part of the SDK initialization process. Gets the shared instance of this SDK engine that can be accessed by any HERE SDK module as the default engine.
getter/setter pair

Static Methods

makeSharedInstance(SDKOptions options) → Future<void>
Makes a new instance of SDKNativeEngine using supplied options and stores it as shared instance see SDKNativeEngine.sharedInstance.