ru.dgis.sdk.navigation.NavigationManager | Android SDK | 2GIS Documentation
Android SDK
Maps
Search
Navigation
On-Premise
Urbi Pro

NavigationManager

Root public interface of the navigator.

Extends: ru.dgis.sdk.NativeObject
NavigationManager(platformContext: Context)

Navigator API entry point used in the SDK by default.

Parameters
platformContext
Returns

Navigator manager object.

Methods
fun start(): Unit

Starts guidance in free roam mode. In this mode, there is no route, and the navigator reports objects that are on the road near the user.

Returns
fun start(routeBuildOptions: RouteBuildOptions, trafficRoute: TrafficRoute? = null): Unit

Starts route guidance.

Parameters
routeBuildOptions
RouteBuildOptions

Parameters with which the navigator rebuilds the route.

trafficRoute
TrafficRoute?

Route to start tracking. If the value is not specified, the navigator builds a route from the current location.

Returns
fun startSimulation(routeBuildOptions: RouteBuildOptions, trafficRoute: TrafficRoute): Unit

Starts a simulation of following the route.

Parameters
routeBuildOptions
RouteBuildOptions

Parameters with which the navigator rebuilds the route.

trafficRoute
TrafficRoute

Route on which to run the simulation.

Returns
fun stop(): Unit

Stops the navigator.

Returns
Properties
val uiModel

The navigator model intended to be displayed in the UI.

val indoorDetector

Indoor navigation.

val mapFollowController

Management of automatic return of the map to tracking a geolocation marker.

val mapManager

Navigator map manager.

val zoomFollowSettings

Map scaling settings during the follow mode.

val routeMapSettings

Settings for displaying the route on the map.

val routeSourceSettings

Settings for the source used to display the route on the map.

val simulationSettings

Settings for simulation of following the route.

val voiceSelector

Managing voice packages in the current navigator session.

val exceedSpeedLimitSettings

Settings for detection of exceeding the speed limit.

val dynamicRouteInfoSettings

Settings for receiving and updating dynamic route data.

val soundNotificationSettings

Settings for sound alerts in the current navigator session.

val freeRoamSettings

Settings for following without a route in free roam mode.

val alternativeRoutesProviderSettings

Alternative route search settings in the follow mode.