LocationEngineBase class abstract

Public abstract class that describes the behaviour of LocationEngine.

Implementation is platform-specific.

Implementers

Constructors

LocationEngineBase(LocationEngineStatus startWithLocationAccuracyLambda(LocationAccuracy), LocationEngineStatus startWithLocationOptionsLambda(LocationOptions), LocationEngineStatus updateLocationAccuracyLambda(LocationAccuracy), LocationEngineStatus updateLocationOptionsLambda(LocationOptions), void stopLambda(), ConfirmationStatus confirmHEREPrivacyNoticeInclusionLambda(), ConfirmationStatus confirmHEREPrivacyNoticeExceptionLambda(), void addLocationListenerLambda(LocationListener), void removeLocationListenerLambda(LocationListener), void addLocationStatusListenerLambda(LocationStatusListener), void removeLocationStatusListenerLambda(LocationStatusListener), void addLocationIssueListenerLambda(LocationIssueListener), void removeLocationIssueListenerLambda(LocationIssueListener), LocationEngineStatus setBackgroundLocationAllowedLambda(bool), bool getBackgroundLocationAllowedLambda(), LocationEngineStatus setBackgroundLocationIndicatorVisibleLambda(bool), bool getBackgroundLocationIndicatorVisibleLambda(), LocationEngineStatus setPauseLocationUpdatesAutomaticallyLambda(bool), bool getPauseLocationUpdatesAutomaticallyLambda(), LocationEngineStatus setLastKnownLocationPersistentLambda(bool), void internalsetCallListenerFromMainThreadEnabledLambda(bool), Location? lastKnownLocationGetLambda(), bool isStartedGetLambda())
Public abstract class that describes the behaviour of LocationEngine.
factory

Properties

hashCode → int
The hash code for this object.
no setterinherited
isStarted → bool
Checks if the engine is in started state. Checks if the engine is in started state.
no setter
lastKnownLocation Location?
The last known location obtained by the LocationEngine. It is persisted throughout the app's lifecycle. This property can be obtained without starting the LocationEngine. However, the initial value might be null if no location has ever been obtained by the LocationEngine. The time attribute of the Location object indicates when the last location was obtained. Note: In order to receive continuous location updates, add a LocationListener. Gets the last known location obtained by the LocationEngine. It is persisted throughout the app's lifecycle.
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

addLocationIssueListener(LocationIssueListener listener) → void
Adds a LocationIssueListener to the engine to get notified when a location issue has occurred.
addLocationListener(LocationListener listener) → void
Adds a LocationListener to the engine to get notified when there is a new location update available.
addLocationStatusListener(LocationStatusListener listener) → void
Adds a LocationStatusListener to the engine to get notified when there is an important status change.
confirmHEREPrivacyNoticeException() ConfirmationStatus
By calling this method, the application developer confirms that they have received an exceptional permission from HERE in written form to not include a reference to the HERE Privacy Notice.
confirmHEREPrivacyNoticeInclusion() ConfirmationStatus
It is the responsibility of the application developer to ensure that the application user is informed about the collection of characteristic information regarding nearby mobile and Wi-Fi network signals.
getBackgroundLocationAllowed() → bool
Check if application's background location updates are enabled.
getBackgroundLocationIndicatorVisible() → bool
Check if application's background location indicator is visible.
getPauseLocationUpdatesAutomatically() → bool
Check if automatic pausing of location updates are enabled.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
removeLocationIssueListener(LocationIssueListener listener) → void
Removes a LocationIssueListener from the engine.
removeLocationListener(LocationListener listener) → void
Removes a LocationListener from the engine.
removeLocationStatusListener(LocationStatusListener listener) → void
Removes a LocationStatusListener from the engine.
setBackgroundLocationAllowed(bool allowed) LocationEngineStatus
Enables or disables background location updates for an application.
setBackgroundLocationIndicatorVisible(bool visible) LocationEngineStatus
Controls visibility of application's background location indicator.
setLastKnownLocationPersistent(bool persistent) LocationEngineStatus
Enables or disables saving of last known location so that it persists between application sessions.
setPauseLocationUpdatesAutomatically(bool allowed) LocationEngineStatus
Controls automatic pausing of location updates e.g.
startWithLocationAccuracy(LocationAccuracy locationAccuracy) LocationEngineStatus
Starts the location engine with desired LocationAccuracy.
startWithLocationOptions(LocationOptions locationOptions) LocationEngineStatus
Starts the location engine with desired LocationOptions.
stop() → void
Stops the location engine.
toString() → String
A string representation of this object.
inherited
updateLocationAccuracy(LocationAccuracy locationAccuracy) LocationEngineStatus
Reconfigures the location engine with desired LocationAccuracy.
updateLocationOptions(LocationOptions locationOptions) LocationEngineStatus
Reconfigures the location engine with desired LocationOptions.

Operators

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

Static Methods

makeLocationEngine(SDKNativeEngine sdkEngine) LocationEngineBase
Creates instance of LocationEngine using factory, registered on platform side
makeLocationEngineFromSharedSdkNativeEngine() LocationEngineBase
Creates instance of LocationEngine using factory, registered on platform side