NavigineSdk Class Reference

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
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 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 39 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

getDeviceId()

static String NavigineSdk.getDeviceId ( )

static

Method returns persistent device id.

Returns

persistent device id

getInstance()

static NavigineSdk NavigineSdk.getInstance ( )

static

Method initializes Navigation library and returns NavigineSdk instance.

Returns

instance of SDK

getLocationListManager()

LocationListManager NavigineSdk.getLocationListManager

(

)

Returns a manager that allows to manage locations list

Returns

Location list manager instance LocationListManager

getLocationManager()

LocationManager NavigineSdk.getLocationManager

(

)

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

Returns

LocationManager instance

getNavigationManager()

NavigationManager NavigineSdk.getNavigationManager

(

LocationManager

locationManager

)

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

Parameters

locationManager

LocationManager instance

Returns

NavigationManager instance

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

getRelativeTime()

static int NavigineSdk.getRelativeTime ( )

static

Method returns current timestamp.

Returns

internal timestamp

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

getVersion()

static String NavigineSdk.getVersion ( )

static

Method returns NavigineSdk SDK Version.

Returns

version of SDK

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

setServer()

void NavigineSdk.setServer

(

String

server

)

Method is used to set server url.

Parameters

server

custom server url in format: http[s]://example.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

---

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

• navigine_sdk.dart