Provides access to all services in the SDK. More...

Inherits Finalizable.

Public Member Functions
void	setUserHash (String userHash)
	Method is used to set `USER_HASH` from the user's profile in CMS.

void	setServer (String server)
	Method is used to set server url.

LocationManager	getLocationManager ()
	LocationManager instance, which could be used for working with the Location.

NavigationManager	getNavigationManager (LocationManager locationManager)
	NavigationManager instance, which could be used for working with the Position.

ZoneManager	getZoneManager (NavigationManager navigationManager)
	ZoneManager instance, which could be used for working with zones and detecting enter and leave events. Zone

RouteManager	getRouteManager (LocationManager locationManager, NavigationManager navigationManager)
	RouteManager instance, which could be used for working making routes, setting target points. RoutePath

AsyncRouteManager	getAsyncRouteManager (LocationManager locationManager, NavigationManager navigationManager)
	AsyncRouteManager instance, which could be used for working with routing sessions. RouteSession

NotificationManager	getNotificationManager (LocationManager locationManager)
	NotificationManager instance, which could be used for working with notifications when detecting beacons. Notification

MeasurementManager	getMeasurementManager (LocationManager locationManager)
	MeasurementManager instance, which could be used for managing measurement generators and handling sensor and signal measurements.

LocationListManager	getLocationListManager ()

StorageManager	getStorageManager ()

UserLocationLayer	getUserLocationLayer (LocationWindow locationWindow)

Static Public Member Functions
static NavigineSdk	getInstance ()
	Method initializes Navigation library and returns NavigineSdk instance.

static String	getVersion ()
	Method returns NavigineSdk SDK Version.

static String	getDeviceId ()
	Method returns persistent device id.

static int	getRelativeTime ()
	Method returns current timestamp.

Detailed Description

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.

Definition at line 41 of file navigine_sdk.dart.

Member Function Documentation

◆ getAsyncRouteManager()

AsyncRouteManager NavigineSdk.getAsyncRouteManager	(	LocationManager	locationManager,
		NavigationManager	navigationManager )

AsyncRouteManager instance, which could be used for working with routing sessions. RouteSession

Parameters

locationManager	LocationManager instance
navigationManager	NavigationManager instance

Returns: AsyncRouteManager instance

Dart code snippet:

    // Get AsyncRouteManager for async route operations
    if (_locationManager != null && _navigationManager != null) {
      _asyncRouteManager = _sdk?.getAsyncRouteManager(
        _locationManager!,
        _navigationManager!,
      );
      if (_asyncRouteManager != null) {
        print('AsyncRouteManager successfully initialized');
      }
    }

◆ getDeviceId()

static String NavigineSdk.getDeviceId ( )

static

Method returns persistent device id.

Returns: persistent device id

Dart code snippet:

// Get device ID

print('Device ID: ${NavigineSdk.getDeviceId()}');

◆ getInstance()

static NavigineSdk NavigineSdk.getInstance ( )

static

Method initializes Navigation library and returns NavigineSdk instance.

Returns: instance of SDK

Dart code snippet:

// Get SDK instance

_sdk = NavigineSdk.getInstance();

◆ getLocationListManager()

LocationListManager NavigineSdk.getLocationListManager ( )

Returns a manager that allows to manage locations list

Returns: Location list manager instance LocationListManager

Dart code snippet:

    // Get LocationListManager for location list operations
    _locationListManager = _sdk?.getLocationListManager();
    if (_locationListManager != null) {
      print('LocationListManager successfully initialized');
    }

◆ getLocationManager()

LocationManager NavigineSdk.getLocationManager ( )

LocationManager instance, which could be used for working with the Location.

Returns: LocationManager instance

Dart code snippet:

    // Get LocationManager for working with locations
    _locationManager = _sdk?.getLocationManager();
    if (_locationManager != null) {
      print('LocationManager successfully initialized');
    }

◆ getMeasurementManager()

MeasurementManager NavigineSdk.getMeasurementManager ( LocationManager locationManager )

MeasurementManager instance, which could be used for managing measurement generators and handling sensor and signal measurements.

Parameters

locationManager LocationManager instance

Returns: MeasurementManager instance

Dart code snippet:

    // Get MeasurementManager for measurements
    if (_locationManager != null) {
      _measurementManager = _sdk?.getMeasurementManager(_locationManager!);
      if (_measurementManager != null) {
        print('MeasurementManager successfully initialized');
      }
    }

◆ getNavigationManager()

NavigationManager NavigineSdk.getNavigationManager ( LocationManager locationManager )

NavigationManager instance, which could be used for working with the Position.

Parameters

locationManager LocationManager instance

Returns: NavigationManager instance

Dart code snippet:

    // Get NavigationManager for navigation
    if (_locationManager != null) {
      _navigationManager = _sdk?.getNavigationManager(_locationManager!);
      if (_navigationManager != null) {
        print('NavigationManager successfully initialized');
      }
    }

◆ getNotificationManager()

NotificationManager NavigineSdk.getNotificationManager ( LocationManager locationManager )

NotificationManager instance, which could be used for working with notifications when detecting beacons. Notification

Parameters

locationManager LocationManager instance

Returns: NotificationManager instance

Dart code snippet:

    // Get NotificationManager for notifications
    if (_locationManager != null) {
      _notificationManager = _sdk?.getNotificationManager(_locationManager!);
      if (_notificationManager != null) {
        print('NotificationManager successfully initialized');
      }
    }

◆ getRelativeTime()

static int NavigineSdk.getRelativeTime ( )

static

Method returns current timestamp.

Returns: internal timestamp

Dart code snippet:

// Get relative time

print('Relative Time: ${NavigineSdk.getRelativeTime()}');

◆ getRouteManager()

RouteManager NavigineSdk.getRouteManager	(	LocationManager	locationManager,
		NavigationManager	navigationManager )

RouteManager instance, which could be used for working making routes, setting target points. RoutePath

Parameters

locationManager	LocationManager instance
navigationManager	NavigationManager instance

Returns: RouteManager instance

Dart code snippet:

    // Get RouteManager for building routes
    if (_locationManager != null && _navigationManager != null) {
      _routeManager = _sdk?.getRouteManager(
        _locationManager!,
        _navigationManager!,
      );
      if (_routeManager != null) {
        print('RouteManager successfully initialized');
      }
    }

◆ getStorageManager()

StorageManager NavigineSdk.getStorageManager ( )

Returns a manager that allows to manage user storages

Returns: Storage manager instance StorageManager

Dart code snippet:

    // Get StorageManager for working with storages
    _storageManager = _sdk?.getStorageManager();
    if (_storageManager != null) {
      print('StorageManager successfully initialized');
    }

◆ getUserLocationLayer()

UserLocationLayer NavigineSdk.getUserLocationLayer ( LocationWindow locationWindow )

Create layer with the user location icon.

◆ getVersion()

static String NavigineSdk.getVersion ( )

static

Method returns NavigineSdk SDK Version.

Returns: version of SDK

Dart code snippet:

// Get SDK version

print('Navigine SDK Version: ${NavigineSdk.getVersion()}');

◆ getZoneManager()

ZoneManager NavigineSdk.getZoneManager ( NavigationManager navigationManager )

ZoneManager instance, which could be used for working with zones and detecting enter and leave events. Zone

Parameters

navigationManager NavigationManager instance

Returns: ZoneManager instance

Dart code snippet:

    // Get ZoneManager for working with zones
    if (_navigationManager != null) {
      _zoneManager = _sdk?.getZoneManager(_navigationManager!);
      if (_zoneManager != null) {
        print('ZoneManager successfully initialized');
      }
    }

◆ setServer()

void NavigineSdk.setServer ( String server )

Method is used to set server url.

Parameters

server custom server url in format: http[s]://example.com

Dart code snippet:

// Set server URL (optional)

_sdk?.setServer('https://custom.navigine.com');

◆ setUserHash()

void NavigineSdk.setUserHash ( String userHash )

Method is used to set USER_HASH from the user's profile in CMS.

Parameters

userHash auth token in format XXXX-XXXX-XXXX-XXXX

Dart code snippet:

// Set user hash (authorization token)

_sdk?.setUserHash('XXXX-XXXX-XXXX-XXXX');

The documentation for this class was generated from the following file:

navigine_sdk.dart

Public Member Functions

Static Public Member Functions

Detailed Description

Member Function Documentation

◆ getAsyncRouteManager()

◆ getDeviceId()

◆ getInstance()

◆ getLocationListManager()

◆ getLocationManager()

◆ getMeasurementManager()

◆ getNavigationManager()

◆ getNotificationManager()

◆ getRelativeTime()

◆ getRouteManager()

◆ getStorageManager()

◆ getUserLocationLayer()

◆ getVersion()

◆ getZoneManager()

◆ setServer()

◆ setUserHash()