com.navigine.idl.java.NavigineSdk Class Reference

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

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

getDeviceId()

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

inlinestatic

Method returns persistent device id.

Returns

persistent device id

Definition at line 153 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

Definition at line 131 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

getLocationManager()

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

abstract

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

Returns

LocationManager instance

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

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

getRelativeTime()

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

inlinestatic

Method returns current timestamp.

Returns

internal timestamp

Definition at line 164 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

getVersion()

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

inlinestatic

Method returns NavigineSdk SDK Version.

Returns

version of SDK

Definition at line 142 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

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

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

---

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

• NavigineSdk.java