navigation-ux-state/com.mapbox.dash.state

Package-level declarations

Types

data class AppData(val state: State = State.FreeDrive.Idle, val mapState: MapState = MapState.Loading, val mapGptState: MapGptState = MapGptState(), val trackingState: TrackingState, val placesPreviewState: PlacesPreviewState = PlacesPreviewState.Idle, val feedbackSearchResult: DestinationSearchResult? = null, val selectedPlace: SelectedPlace? = null, val selectedWaypoint: DestinationSearchResult? = null, val waypointToBeReplaced: DestinationSearchResult? = null, val fetchingState: FetchingState = FetchingState.None, val tripState: TripState = TripState(), val activeTripState: TripState? = null, val weather: PlaceWeather = PlaceWeather.NoWeather, val navigationManagerIntent: NavigationManagerIntent = NavigationManagerIntent.Idle, val resumeNavigationIntent: ResumeNavigationIntent = ResumeNavigationIntent.Idle, val selectedManeuver: RouteManeuver? = null, val maneuverState: ManeuverState = ManeuverState.Gone, val viewsVisibility: ViewsVisibility = ViewsVisibility(), val allowToEndRoutInOneClick: Boolean = false, val chargingPort: Port? = null, val isCharging: Boolean = false, val searchAnchor: Point? = null, val lastKnownDestination: LastKnownDestination? = null, val navigationSuggestions: List<DashNavigationSuggestion> = emptyList())

AppError

sealed class AppError

AppNotification

sealed class AppNotification

AppStore

open class AppStore(initialState: State = FreeDrive.Idle, logger: Logger, scope: CoroutineScope, appDataReducer: AppDataReducer, appDataFactory: AppDataFactory)

AudioStageViewState

data class AudioStageViewState(val isVisible: Boolean = true, val viewType: AudioStateViewType = SMALL)

AudioStateViewType

enum AudioStateViewType : Enum<AudioStateViewType>

CameraTrackingMode

enum CameraTrackingMode : Enum<CameraTrackingMode>

ConnectivityError

class ConnectivityError(val type: ConnectivityErrorType, val throwable: Throwable? = null, val message: String? = null) : AppError

ConnectivityErrorType

enum ConnectivityErrorType : Enum<ConnectivityErrorType>

Event

sealed class Event

FetchingState

enum FetchingState : Enum<FetchingState>

FullScreenMessageType

enum FullScreenMessageType : Enum<FullScreenMessageType>

LastKnownDestination

data class LastKnownDestination(val placeName: String, val coordinate: Point)

ManeuverState

enum ManeuverState : Enum<ManeuverState>

MapState

sealed class MapState

NavigationManagerIntent

sealed class NavigationManagerIntent

NotAvailableWhileDrivingNotification

class NotAvailableWhileDrivingNotification(val message: String? = null) : AppNotification

PlacesPreviewState

interface PlacesPreviewState

PlaceWeather

sealed class PlaceWeather

RecenterState

data class RecenterState(val visible: Boolean, val trackingMode: CameraTrackingMode)

ResumeNavigationIntent

sealed class ResumeNavigationIntent

ReturnState

interface ReturnState

Defines where to return from the RoutePreview and nested states.

RouteOverviewCancelSource

enum RouteOverviewCancelSource : Enum<RouteOverviewCancelSource>

RouteOverviewEventSource

enum RouteOverviewEventSource : Enum<RouteOverviewEventSource>

RoutingError

class RoutingError(val throwable: Throwable?, val message: String? = null) : AppError

SearchError

class SearchError(val throwable: Throwable? = null, val message: String? = null) : AppError

SearchType

enum SearchType : Enum<SearchType>

SelectedPlace

sealed class SelectedPlace

State

sealed class State

StateTransition

data class StateTransition(val from: State, val appDataFrom: AppData, val to: State, val appDataTo: AppData, val event: Event)

TestAppStore

@VisibleForTesting

class TestAppStore : AppStore

TrackingState

data class TrackingState(val cameraState: CameraState, val recenterState: RecenterState, val puckTracking: Boolean)

TripState

data class TripState(val waypoints: List<DestinationSearchResult> = emptyList(), val markers: List<Marker> = emptyList(), val routes: List<NavigationRoute> = emptyList(), val fasterRoutes: List<FasterRouteMetadata> = emptyList(), val routeWithChargers: NavigationRoute? = null, val currentLegIndex: Int = 0, savedState: TripState? = null)

Properties

canAddRegularWaypoint

val TripState.canAddRegularWaypoint: Boolean

canRemoveRegularWaypoint

val TripState.canRemoveRegularWaypoint: Boolean

isNotEmpty

val TripState.isNotEmpty: Boolean

Functions

captureReturnState

fun AppStore.captureReturnState(): ReturnState

createTestAppDataFactory

@VisibleForTesting

fun createTestAppDataFactory(): AppDataFactory

reduceMapState

fun AppData.reduceMapState(event: Event): MapState

toggleBetween

fun CameraTrackingMode.toggleBetween(first: CameraTrackingMode, second: CameraTrackingMode): CameraTrackingMode

toggleBetweenOrDefault

fun CameraTrackingMode.toggleBetweenOrDefault(default: CameraTrackingMode, second: CameraTrackingMode): CameraTrackingMode