NavigationViewModel

open class NavigationViewModel : AndroidViewModel

Constructors

NavigationViewModel

open fun NavigationViewModel(application: Application)

NavigationViewModel

@TestOnly()

open fun NavigationViewModel(application: Application, navigation: MapboxNavigation, navigationViewOptions: NavigationViewOptions)

NavigationViewModel

@TestOnly()

open fun NavigationViewModel(application: Application, navigation: MapboxNavigation, dispatcher: NavigationViewEventDispatcher, cache: VoiceInstructionCache, speechPlayer: SpeechPlayer)

Types

FeedbackFlowStatus

@Retention(value = RetentionPolicy.SOURCE)

annotation class FeedbackFlowStatus

Functions

clear

fun clear()

closeWithRuntimeException

open fun closeWithRuntimeException(obj: Any)

enableArrivalExperienceFeedback

open fun enableArrivalExperienceFeedback(): Boolean

enableDetailedFeedbackFlowAfterTbt

open fun enableDetailedFeedbackFlowAfterTbt(): Boolean

getApplication

open fun <T : Application?> getApplication(): T

getTag

open fun <T> getTag(key: String): T

initialize

open fun initialize(options: NavigationViewOptions)

This method will pass NavigationOptions from the NavigationViewOptions to this view model to be used to initialize MapboxNavigation.

initializeEventDispatcher

open fun initializeEventDispatcher(navigationViewEventDispatcher: NavigationViewEventDispatcher)

isMuted

open fun isMuted(): Boolean

onCleared

open fun onCleared()

onDestroy

open fun onDestroy(isChangingConfigurations: Boolean)

onDetailedFeedbackFlowFinished

open fun onDetailedFeedbackFlowFinished()

retrieveBannerInstructions

@NonNull()

open fun retrieveBannerInstructions(): LiveData<BannerInstructions>

retrieveDestination

@NonNull()

open fun retrieveDestination(): LiveData<Point>

retrieveFeedbackFlowStatus

@NonNull()

open fun retrieveFeedbackFlowStatus(): LiveData<Integer>

retrieveIsOffRoute

@NonNull()

open fun retrieveIsOffRoute(): LiveData<Boolean>

retrieveNavigation

@Nullable()

open fun retrieveNavigation(): MapboxNavigation

Returns the current instance of MapboxNavigation.

retrieveNavigationLocation

@NonNull()

open fun retrieveNavigationLocation(): LiveData<Location>

retrieveOnFinalDestinationArrival

@NonNull()

open fun retrieveOnFinalDestinationArrival(): LiveData<Boolean>

retrieveRoute

@NonNull()

open fun retrieveRoute(): LiveData<DirectionsRoute>

retrieveRouteProgress

@NonNull()

open fun retrieveRouteProgress(): LiveData<RouteProgress>

retrieveShouldRecordScreenshot

@NonNull()

open fun retrieveShouldRecordScreenshot(): LiveData<Boolean>

setMuted

open fun setMuted(isMuted: Boolean)

setTagIfAbsent

open fun <T> setTagIfAbsent(key: String, newValue: T): T

stopNavigation

open fun stopNavigation()

takeScreenshot

open fun takeScreenshot()

updateFeedback

open fun updateFeedback(feedbackItem: FeedbackItem)

Used to update an existing FeedbackItem with a feedback type and description.

updateFeedbackScreenshot

open fun updateFeedbackScreenshot(screenshot: String)

updateLocation

open fun updateLocation(location: Location)

updateRouteProgress

open fun updateRouteProgress(routeProgress: RouteProgress)

Properties

distanceFormatter

@Nullable()

private open val distanceFormatter: DistanceFormatter

FEEDBACK_FLOW_CANCEL

val FEEDBACK_FLOW_CANCEL: Int

FEEDBACK_FLOW_CANCEL means the FeedbackBottomSheet dismisses.

FEEDBACK_FLOW_IDLE

val FEEDBACK_FLOW_IDLE: Int

FEEDBACK_FLOW_IDLE means the FeedbackBottomSheet is currently shownand is waiting for user's selection.

FEEDBACK_FLOW_SENT

val FEEDBACK_FLOW_SENT: Int

FEEDBACK_FLOW_SENT means the user has selected a FeedbackEvent.Type and the FeedbackBottomSheet dismisses.

isRunning

private open val isRunning: Boolean

navigationViewOptions

private open val navigationViewOptions: NavigationViewOptions