com.mapbox.services.android.navigation.ui.v5

Class NavigationViewModel

java.lang.Object

android.arch.lifecycle.ViewModel

android.arch.lifecycle.AndroidViewModel

com.mapbox.services.android.navigation.ui.v5.NavigationViewModel

public class NavigationViewModel
extends android.arch.lifecycle.AndroidViewModel

Field Summary

Fields

Modifier and Type	Field and Description
android.arch.lifecycle.MutableLiveData<BannerInstructionModel>	bannerInstructionModel
android.arch.lifecycle.MutableLiveData<InstructionModel>	instructionModel
android.arch.lifecycle.MutableLiveData<java.lang.Boolean>	isOffRoute
android.arch.lifecycle.MutableLiveData<SummaryModel>	summaryModel

Constructor Summary

Constructors

Constructor and Description
NavigationViewModel(android.app.Application application)

Method Summary

Modifier and Type	Method and Description
void	cancelFeedback() Used to cancel an existing FeedbackItem.
void	onDestroy(boolean isChangingConfigurations)
void	recordFeedback(java.lang.String feedbackSource) Records a general feedback item with source
com.mapbox.services.android.navigation.v5.navigation.MapboxNavigation	retrieveNavigation() Returns the current instance of MapboxNavigation.
void	setMuted(boolean isMuted)
void	updateFeedback(FeedbackItem feedbackItem) Used to update an existing FeedbackItem with a feedback type and description.

Methods inherited from class android.arch.lifecycle.AndroidViewModel

getApplication

Methods inherited from class android.arch.lifecycle.ViewModel

onCleared

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

instructionModel

public final android.arch.lifecycle.MutableLiveData<InstructionModel> instructionModel

bannerInstructionModel

public final android.arch.lifecycle.MutableLiveData<BannerInstructionModel> bannerInstructionModel

summaryModel

public final android.arch.lifecycle.MutableLiveData<SummaryModel> summaryModel

isOffRoute

public final android.arch.lifecycle.MutableLiveData<java.lang.Boolean> isOffRoute

Constructor Detail

NavigationViewModel

public NavigationViewModel(android.app.Application application)

Method Detail

onDestroy

public void onDestroy(boolean isChangingConfigurations)

setMuted

public void setMuted(boolean isMuted)

recordFeedback

public void recordFeedback(java.lang.String feedbackSource)

Records a general feedback item with source

updateFeedback

public void updateFeedback(FeedbackItem feedbackItem)

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

Uses cached feedbackId to ensure the proper item is updated.

Parameters:

feedbackItem - item to be updated

Since:

0.7.0

cancelFeedback

public void cancelFeedback()

Used to cancel an existing FeedbackItem.

Uses cached feedbackId to ensure the proper item is cancelled.

Since:

0.7.0

retrieveNavigation

@Nullable
public com.mapbox.services.android.navigation.v5.navigation.MapboxNavigation retrieveNavigation()

Returns the current instance of MapboxNavigation.

Will be null if navigation has not been initialized.