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

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

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

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

abstract NavigationManager	getNavigationManager (LocationManager locationManager)
	NavigationManager instance, which could be used for working with the com.navigine.idl.java.Position.

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

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

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

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

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

abstract LocationListManager	getLocationListManager ()

abstract StorageManager	getStorageManager ()

abstract 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 long	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 22 of file NavigineSdk.java.

Member Function Documentation

◆ getAsyncRouteManager()

abstract AsyncRouteManager com.navigine.idl.java.NavigineSdk.getAsyncRouteManager	(	LocationManager	locationManager,
		NavigationManager	navigationManager )

abstract

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

Parameters

locationManager	LocationManager instance
navigationManager	NavigationManager instance

Returns: AsyncRouteManager instance

Java code snippet:

        // Get AsyncRouteManager for async route operations
        if (locationManager != null && navigationManager != null) {
            asyncRouteManager = sdk.getAsyncRouteManager(locationManager, navigationManager);
            if (asyncRouteManager != null) {
                System.out.println("AsyncRouteManager successfully initialized");
            }
        }

Kotlin code snippet:

            // Get AsyncRouteManager for async route operations
            locationManager?.let { locationManager ->
                navigationManager?.let { navigationManager ->
                    asyncRouteManager = sdkInstance.getAsyncRouteManager(locationManager, navigationManager)
                    asyncRouteManager?.let {
                        println("AsyncRouteManager successfully initialized")
                    }
                }
            }

◆ getDeviceId()

static String com.navigine.idl.java.NavigineSdk.getDeviceId ( )

inlinestatic

Method returns persistent device id.

Returns: persistent device id

Java code snippet:

// Get device ID

System.out.println("Device ID: " + NavigineSdk.getDeviceId());

Kotlin code snippet:

// Get device ID

println("Device ID: ${NavigineSdk.getDeviceId()}")

Definition at line 287 of file NavigineSdk.java.

◆ getInstance()

static NavigineSdk com.navigine.idl.java.NavigineSdk.getInstance ( )

inlinestatic

Method initializes Navigation library and returns NavigineSdk instance.

Returns: instance of SDK

Java code snippet:

// Get SDK instance

sdk = NavigineSdk.getInstance();

Kotlin code snippet:

// Get SDK instance

sdk = NavigineSdk.getInstance()

Definition at line 249 of file NavigineSdk.java.

◆ getLocationListManager()

abstract LocationListManager com.navigine.idl.java.NavigineSdk.getLocationListManager ( )

abstract

Returns a manager that allows to manage locations list

Returns: Location list manager instance LocationListManager

Java code snippet:

        // Get LocationListManager for location list operations
        locationListManager = sdk.getLocationListManager();
        if (locationListManager != null) {
            System.out.println("LocationListManager successfully initialized");
        }

Kotlin code snippet:

            // Get LocationListManager for location list operations
            locationListManager = sdkInstance.locationListManager
            locationListManager?.let {
                println("LocationListManager successfully initialized")
            }

◆ getLocationManager()

abstract LocationManager com.navigine.idl.java.NavigineSdk.getLocationManager ( )

abstract

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

Returns: LocationManager instance

Java code snippet:

        // Get LocationManager for working with locations
        locationManager = sdk.getLocationManager();
        if (locationManager != null) {
            System.out.println("LocationManager successfully initialized");
        }

Kotlin code snippet:

            // Get LocationManager for working with locations
            locationManager = sdkInstance.locationManager
            locationManager?.let {
                println("LocationManager successfully initialized")
            }

◆ getMeasurementManager()

abstract MeasurementManager com.navigine.idl.java.NavigineSdk.getMeasurementManager ( LocationManager locationManager )

abstract

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

Parameters

locationManager LocationManager instance

Returns: MeasurementManager instance

Java code snippet:

        // Get MeasurementManager for measurements
        if (locationManager != null) {
            measurementManager = sdk.getMeasurementManager(locationManager);
            if (measurementManager != null) {
                System.out.println("MeasurementManager successfully initialized");
            }
        }

Kotlin code snippet:

            // Get MeasurementManager for measurements
            locationManager?.let { locationManager ->
                measurementManager = sdkInstance.getMeasurementManager(locationManager)
                measurementManager?.let {
                    println("MeasurementManager successfully initialized")
                }
            }

◆ getNavigationManager()

abstract NavigationManager com.navigine.idl.java.NavigineSdk.getNavigationManager ( LocationManager locationManager )

abstract

NavigationManager instance, which could be used for working with the com.navigine.idl.java.Position.

Parameters

locationManager LocationManager instance

Returns: NavigationManager instance

Java code snippet:

        // Get NavigationManager for navigation
        if (locationManager != null) {
            navigationManager = sdk.getNavigationManager(locationManager);
            if (navigationManager != null) {
                System.out.println("NavigationManager successfully initialized");
            }
        }

Kotlin code snippet:

            // Get NavigationManager for navigation
            locationManager?.let { locationManager ->
                navigationManager = sdkInstance.getNavigationManager(locationManager)
                navigationManager?.let {
                    println("NavigationManager successfully initialized")
                }
            }

◆ getNotificationManager()

abstract NotificationManager com.navigine.idl.java.NavigineSdk.getNotificationManager ( LocationManager locationManager )

abstract

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

Parameters

locationManager LocationManager instance

Returns: NotificationManager instance

Java code snippet:

        // Get NotificationManager for notifications
        if (locationManager != null) {
            notificationManager = sdk.getNotificationManager(locationManager);
            if (notificationManager != null) {
                System.out.println("NotificationManager successfully initialized");
            }
        }

Kotlin code snippet:

            // Get NotificationManager for notifications
            locationManager?.let { locationManager ->
                notificationManager = sdkInstance.getNotificationManager(locationManager)
                notificationManager?.let {
                    println("NotificationManager successfully initialized")
                }
            }

◆ getRelativeTime()

static long com.navigine.idl.java.NavigineSdk.getRelativeTime ( )

inlinestatic

Method returns current timestamp.

Returns: internal timestamp

Java code snippet:

// Get relative time

System.out.println("Relative Time: " + NavigineSdk.getRelativeTime());

Kotlin code snippet:

// Get relative time

println("Relative Time: ${NavigineSdk.getRelativeTime()}")

Definition at line 306 of file NavigineSdk.java.

◆ getRouteManager()

abstract RouteManager com.navigine.idl.java.NavigineSdk.getRouteManager	(	LocationManager	locationManager,
		NavigationManager	navigationManager )

abstract

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

Parameters

locationManager	LocationManager instance
navigationManager	NavigationManager instance

Returns: RouteManager instance

Java code snippet:

        // Get RouteManager for building routes
        if (locationManager != null && navigationManager != null) {
            routeManager = sdk.getRouteManager(locationManager, navigationManager);
            if (routeManager != null) {
                System.out.println("RouteManager successfully initialized");
            }
        }

Kotlin code snippet:

            // Get RouteManager for building routes
            locationManager?.let { locationManager ->
                navigationManager?.let { navigationManager ->
                    routeManager = sdkInstance.getRouteManager(locationManager, navigationManager)
                    routeManager?.let {
                        println("RouteManager successfully initialized")
                    }
                }
            }

◆ getStorageManager()

abstract StorageManager com.navigine.idl.java.NavigineSdk.getStorageManager ( )

abstract

Returns a manager that allows to manage user storages

Returns: Storage manager instance StorageManager

Java code snippet:

        // Get StorageManager for working with storages
        storageManager = sdk.getStorageManager();
        if (storageManager != null) {
            System.out.println("StorageManager successfully initialized");
        }

Kotlin code snippet:

            // Get StorageManager for working with storages
            storageManager = sdkInstance.storageManager
            storageManager?.let {
                println("StorageManager successfully initialized")
            }

◆ getUserLocationLayer()

abstract UserLocationLayer com.navigine.idl.java.NavigineSdk.getUserLocationLayer ( LocationWindow locationWindow )

abstract

Create layer with the user location icon.

◆ getVersion()

static String com.navigine.idl.java.NavigineSdk.getVersion ( )

inlinestatic

Method returns NavigineSdk SDK Version.

Returns: version of SDK

Java code snippet:

// Get SDK version

System.out.println("Navigine SDK Version: " + NavigineSdk.getVersion());

Kotlin code snippet:

// Get SDK version

println("Navigine SDK Version: ${NavigineSdk.getVersion()}")

Definition at line 268 of file NavigineSdk.java.

◆ getZoneManager()

abstract ZoneManager com.navigine.idl.java.NavigineSdk.getZoneManager ( NavigationManager navigationManager )

abstract

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

Parameters

navigationManager NavigationManager instance

Returns: ZoneManager instance

Java code snippet:

        // Get ZoneManager for working with zones
        if (navigationManager != null) {
            zoneManager = sdk.getZoneManager(navigationManager);
            if (zoneManager != null) {
                System.out.println("ZoneManager successfully initialized");
            }
        }

Kotlin code snippet:

            // Get ZoneManager for working with zones
            navigationManager?.let { navigationManager ->
                zoneManager = sdkInstance.getZoneManager(navigationManager)
                zoneManager?.let {
                    println("ZoneManager successfully initialized")
                }
            }

◆ setServer()

abstract void com.navigine.idl.java.NavigineSdk.setServer ( String server )

abstract

Method is used to set server url.

Parameters

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

Java code snippet:

// Set server URL (optional)

sdk.setServer("https://custom.navigine.com");

Kotlin code snippet:

// Set server URL (optional)

sdk?.setServer("https://custom.navigine.com")

◆ setUserHash()

abstract void com.navigine.idl.java.NavigineSdk.setUserHash ( String userHash )

abstract

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

Parameters

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

Java code snippet:

// Set user hash (authorization token)

sdk.setUserHash("XXXX-XXXX-XXXX-XXXX");

Kotlin code snippet:

// Set user hash (authorization token)

sdk?.setUserHash("XXXX-XXXX-XXXX-XXXX")

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

NavigineSdk.java

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()