NCNavigineSdk Class Reference

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

#include <com/navigine/idl/objc/NCNavigineSdk.h>

Inherits NSObject.

Instance Methods
(void)	- setUserHash:
	Method is used to set USER_HASH from the user's profile in CMS.
(void)	- setServer:
	Method is used to set server url.
(nullable NCLocationManager *)	- getLocationManager
	LocationManager instance, which could be used for working with the Location.
(nullable NCNavigationManager *)	- getNavigationManager:
	NavigationManager instance, which could be used for working with the NCPosition.
(nullable NCZoneManager *)	- getZoneManager:
	ZoneManager instance, which could be used for working with zones and detecting enter and leave events. Zone
(nullable NCRouteManager *)	- getRouteManager:navigationManager:
	RouteManager instance, which could be used for working making routes, setting target points. RoutePath
(nullable NCAsyncRouteManager *)	- getAsyncRouteManager:navigationManager:
	AsyncRouteManager instance, which could be used for working with routing sessions. RouteSession
(nullable NCNotificationManager *)	- getNotificationManager:
	NotificationManager instance, which could be used for working with notifications when detecting beacons. Notification
(nullable NCLocationListManager *)	- getLocationListManager

Class Methods
(nullable NCNavigineSdk *)	+ getInstance
	Method initializes Navigation library and returns NavigineSdk instance.
(nonnull NSString *)	+ getVersion
	Method returns NavigineSdk SDK Version.
(nonnull NSString *)	+ getDeviceId
	Method returns persistent device id.
(int64_t)	+ 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 37 of file NCNavigineSdk.h.

Method Documentation

getAsyncRouteManager:navigationManager:

- (nullable NCAsyncRouteManager *) getAsyncRouteManager:		(nullable NCLocationManager *)	locationManager
navigationManager:		(nullable NCNavigationManager *)	navigationManager

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

Parameters

locationManager	LocationManager instance
navigationManager	NavigationManager instance

Returns

AsyncRouteManager instance

getDeviceId

+ (nonnull NSString *) getDeviceId

Method returns persistent device id.

Returns

persistent device id

getInstance

+ (nullable NCNavigineSdk *) getInstance

Method initializes Navigation library and returns NavigineSdk instance.

Returns

instance of SDK

getLocationListManager

- (nullable NCLocationListManager *) getLocationListManager

Returns a manager that allows to manage locations list

Returns

Location list manager instance LocationListManager

getLocationManager

- (nullable NCLocationManager *) getLocationManager

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

Returns

LocationManager instance

getNavigationManager:

- (nullable NCNavigationManager *) getNavigationManager:

(nullable NCLocationManager *)

locationManager

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

Parameters

locationManager

LocationManager instance

Returns

NavigationManager instance

getNotificationManager:

- (nullable NCNotificationManager *) getNotificationManager:

(nullable NCLocationManager *)

locationManager

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

Parameters

locationManager

LocationManager instance

Returns

NotificationManager instance

getRelativeTime

+ (int64_t) getRelativeTime

Method returns current timestamp.

Returns

internal timestamp

getRouteManager:navigationManager:

- (nullable NCRouteManager *) getRouteManager:		(nullable NCLocationManager *)	locationManager
navigationManager:		(nullable NCNavigationManager *)	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

+ (nonnull NSString *) getVersion

Method returns NavigineSdk SDK Version.

Returns

version of SDK

getZoneManager:

- (nullable NCZoneManager *) getZoneManager:

(nullable NCNavigationManager *)

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) setServer:

(nonnull NSString *)

server

Method is used to set server url.

Parameters

server

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

setUserHash:

- (void) setUserHash:

(nonnull NSString *)

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:

• NCNavigineSdk.h