NavigineSdk class abstract

@ingroup navigine_dart_classes @ingroup navigine_dart_sdk @brief Provides access to all services in the SDK.

Class contains a list of static functions for initializing library and list of functions for getting access to the managers, each of which will provide different opportunities for working with SDK

@note SDK holds objects by weak references. You need to have strong references to them somewhere in the client code.

Implemented types
Implementers

Constructors

Properties

hashCode int
The hash code for this object.
no setterinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited

Methods

createLocationWindow(PlatformView platformView) LocationWindow
getAsyncRouteManager(LocationManager locationManager, NavigationManager navigationManager) AsyncRouteManager
@brief @see AsyncRouteManager "AsyncRouteManager" instance, which could be used for working with routing sessions. @see RouteSession "RouteSession" @param locationManager @see LocationManager "LocationManager" instance @param navigationManager @see NavigationManager "NavigationManager" instance @return @see AsyncRouteManager "AsyncRouteManager" instance
getBeaconProximityEstimator(LocationManager locationManager) BeaconProximityEstimator
getErrorDescription(int errorCode) String
getLocationEditManager(LocationManager locationManager) LocationEditManager
getLocationListManager() LocationListManager
@endcond
getLocationManager() LocationManager
@brief @see LocationManager "LocationManager" instance, which could be used for working with the @see Location "Location". @return @see LocationManager "LocationManager" instance
getMeasurementManager(LocationManager locationManager) MeasurementManager
@brief @see MeasurementManager "MeasurementManager" instance, which could be used for managing measurement generators and handling sensor and signal measurements. @param locationManager @see LocationManager "LocationManager" instance @return @see MeasurementManager "MeasurementManager" instance
getMqttSession(NavigationManager navigationManager) MqttSession
@brief @see MqttSession "MqttSession" instance, which could be used for working with MQTT sessions. @param navigationManager @see NavigationManager "NavigationManager" instance @return @see MqttSession "MqttSession" instance
getNavigationManager(LocationManager locationManager) NavigationManager
@brief @see NavigationManager "NavigationManager" instance, which could be used for working with the @see Position. @param locationManager @see LocationManager "LocationManager" instance @return @see NavigationManager "NavigationManager" instance
getNotificationManager(LocationManager locationManager) NotificationManager
@brief @see NotificationManager "NotificationManager" instance, which could be used for working with notifications when detecting beacons. @see Notification "Notification" @param locationManager @see LocationManager "LocationManager" instance @return @see NotificationManager "NotificationManager" instance
getResourceManager(LocationManager locationManager) ResourceManager
@cond
getRouteManager(LocationManager locationManager, NavigationManager navigationManager) RouteManager
@brief @see RouteManager "RouteManager" instance, which could be used for working making routes, setting target points. @see RoutePath "RoutePath" @param locationManager @see LocationManager "LocationManager" instance @param navigationManager @see NavigationManager "NavigationManager" instance @return @see RouteManager "RouteManager" instance
getStorageManager() StorageManager
Returns a manager that allows to manage user storages @return Storage manager instance @see StorageManager "StorageManager"
getUserLocationLayer(LocationWindow locationWindow) UserLocationLayer
Create layer with the user location icon.
getZoneManager(NavigationManager navigationManager) ZoneManager
@brief @see ZoneManager "ZoneManager" instance, which could be used for working with zones and detecting enter and leave events. @see Zone "Zone" @param navigationManager @see NavigationManager "NavigationManager" instance @return @see ZoneManager "ZoneManager" instance
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
setServer(String server) → void
@brief Method is used to set server url @param server custom server url in format: http[s]://example.com
setUserHash(String userHash) → void
@brief Method is used to set USER_HASH from the user's profile in CMS @param userHash auth token in format XXXX-XXXX-XXXX-XXXX
toString() String
A string representation of this object.
inherited

Operators

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

Static Methods

getDeviceId() String
@brief Method returns persistent device id. @return persistent device id
getInstance() NavigineSdk
@brief Method initializes Navigation library and returns NavigineSdk instance. @return instance of SDK
getRelativeTime() int
@brief Method returns current timestamp. @return internal timestamp
getVersion() String
@brief Method returns NavigineSdk SDK Version. @return version of SDK