sdk/com.naviexpert.navigationsdk.api/NavigationApi

NavigationApi

Properties

open override val errorsState: StateFlow<Errors>

SDK and navigation errors state - monitor it to resolve problems (for example enable internet connection, gps etc.) or contact with developer (for example API key expired etc.) Custom implementation of StateFlow guarantees all changes to be notify - no conflation.

etaDataState

open override val etaDataState: StateFlow<EtaModel?>

A StateFlow representing eta data required by EtaBar. Pass this to the composable EtaBar as the speedState parameter.

laneAssistantState

open override val laneAssistantState: StateFlow<LaneAssistantModel?>

A StateFlow representing data required by the LaneAssistant composable. Pass this to the composable LaneAssistant.

locationState

open override val locationState: StateFlow<LocationModel?>

A StateFlow providing data for position tracking and displaying an indicator on a map.

maneuversDataState

open override val maneuversDataState: StateFlow<ManeuversModel?>

A StateFlow representing upcoming maneuver information ManeuversBar. Pass this to the composable ManeuversBar.

navigationState

open override val navigationState: StateFlow<NavigationState>

A StateFlow representing the current state of the navigation session

routesDataState

open override val routesDataState: StateFlow<RoutesModel?>

A StateFlow providing data drawing route or showing route bounds.

sdkState

open override val sdkState: StateFlow<SdkState>

A StateFlow representing the current state of the SDK

soundState

open override val soundState: StateFlow<SoundState>

A StateFlow providing data about current voice guidance state.

speedState

open override val speedState: StateFlow<SpeedModel?>

A StateFlow representing current speed and speedLimit. Pass this to the composable SpeedView

Functions

awaitNavigationState

open suspend override fun awaitNavigationState(state: NavigationState, action: () -> Unit?)

Helper method that suspends until Navigation reaches desired state (and launches action if defined).

awaitSdkAndNavigationState

open suspend override fun awaitSdkAndNavigationState(sdkState: SdkState, navigationState: NavigationState, action: () -> Unit?)

Helper method that suspends until SDK and Navigation reaches desired state (and launches action if defined).

awaitSdkState

open suspend override fun awaitSdkState(state: SdkState, action: () -> Unit?)

Helper method that suspends until SDK reaches desired state (and launches action if defined).

canStopNavigation

open override fun canStopNavigation(): Boolean

Helper method that indicates if navigation can be stopped.

dispose

open override fun dispose()

Stops any ongoing operations (including location tracking or foreground service if active etc.), cleans up internal state and releasing resources. Call this when NavigationApi is no longer needed.

getNavigationViewModel

open override fun getNavigationViewModel(owner: ViewModelStoreOwner): IOverlayViewModel

Retrieves the IOverlayViewModel associated with the provided ViewModelStoreOwner (typically an Activity or Fragment). This ViewModel is designed for use with the NavigationMapView composable function.

init

open override fun init(initParams: InitParams)

Initializes the SDK with the provided init parameters. This method must be called before any other SDK operations.

navigate

@RequiresPermission(allOf = ["android.permission.ACCESS_FINE_LOCATION", "android.permission.ACCESS_COARSE_LOCATION"])

open override fun navigate(navigationParams: NavigationParams)

Initiates navigation to the specified parameters.

sendReport

open override fun sendReport(reportParams: ReportParams): Deferred<Boolean>

Sends a report to the server.

startLocationTracking

@RequiresPermission(allOf = ["android.permission.ACCESS_FINE_LOCATION", "android.permission.ACCESS_COARSE_LOCATION"])

open override fun startLocationTracking()

Initiates requests for location updates.

startNavigationActivity

open override fun startNavigationActivity(context: Context, stopNavigationOnActivityDestroy: Boolean)

Starts default activity with map and all navigation views to visualise active navigation session.

startVoiceGuidance

open override fun startVoiceGuidance()

Enables the voice navigation prompts.

stopLocationTracking

open override fun stopLocationTracking()

Stops the active location tracking process.

stopNavigation

open override fun stopNavigation()

Stops the currently active navigation session. This will typically stop any ongoing route guidance, remove the navigation UI, and, if a foreground service was started, stop the foreground service.

stopVoiceGuidance

open override fun stopVoiceGuidance()

Disables the voice navigation prompts.

updateNavigation

open override fun updateNavigation(event: NavigationEvent.Update, forced: Boolean)

Updates the currently ongoing navigation session.