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

Package-level declarations

Types

class ArrivalInformation @RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX]) constructor( val formatter: ArrivalInformationFormatter, val etaDistance: EtaDistance, val stateOfCharge: Int? = null, val stateOfChargeOnReturn: Int? = null, val isOffline: Boolean = false, val arrivalCoordinate: Point? = null)

ArrivalInformationFormatter

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])

interface ArrivalInformationFormatter

Category

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])

sealed class Category

ChargeData

class ChargeData @RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX]) constructor( val chargeFromPercent: Int, val chargeToPercent: Int, val chargeForMin: Long, val powerKw: Int)

Defines how many minutes required from to charge to the given percent with given power (kW).

CommerceManager

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])

interface CommerceManager

CongestionRates

class CongestionRates @RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX]) constructor( val lowCongestionRange: IntRange, val moderateCongestionRange: IntRange, val heavyCongestionRange: IntRange, val severeCongestionRange: IntRange, val lowCongestionColor: Color, val moderateCongestionColor: Color, val heavyCongestionColor: Color, val severeCongestionColor: Color)

DestinationImageInfo

class DestinationImageInfo @RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX]) constructor(val url: String, val width: Int, val height: Int)

DestinationMetadata

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])

data class DestinationMetadata( val extraData: Map<String, String> = emptyMap(), val reviewCount: Int? = null, val phone: String? = null, val website: String? = null, val rating: Float? = null, val description: String? = null, val photos: List<DestinationImageInfo> = emptyList(), val openHours: HoursOfOperation? = null, val plugShareData: PlugShareData? = null, val searchResultMetadata: SearchResultMetadata? = null, val stateOfCharge: Int? = null, val children: List<DestinationResultSuggestedItem> = emptyList())

DestinationResultSuggestedItem

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])

interface DestinationResultSuggestedItem

DestinationSearchResult

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])

data class DestinationSearchResult( val originalSearchModel: OriginalSearchModel, val address: SearchAddress?, val clickCoordinate: Point? = null, val coordinate: Point, val etaMinutes: Double?, val id: String, val metadata: DestinationMetadata?, val name: String, val shortName: String? = null, val routablePoints: List<RoutablePoint>?, val type: SearchResultType, val categories: List<String>?, val makiIcon: String?, val distance: Double?, val descriptionText: String?, val destinationSource: DestinationSource = DestinationSource.MBX, val mapboxId: String? = null, val isOffline: Boolean = false)

DestinationSource

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])

enum DestinationSource : Enum<DestinationSource>

DisableMapboxCommerceManager

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])

class DisableMapboxCommerceManager : CommerceManager

EtaDistance

class EtaDistance @RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX]) constructor(val etaMinutes: Double?, val distance: Double?)

HoursOfOperation

abstract class HoursOfOperation

Marker

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])

data class Marker(val type: Marker.Type, val point: Point, val categories: List<String>, val selected: Boolean = false)

OpenPeriod

class OpenPeriod @RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX]) constructor( val open: WeekTimestamp, val closed: WeekTimestamp)

OriginalSearchModel

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])

sealed class OriginalSearchModel

Outlet

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])

data class Outlet(val id: String? = null, val connector: Int? = null, val kilowatts: Int? = null, val power: Int? = null)

PlugShareData

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])

data class PlugShareData(val id: String? = null, val networkId: String? = null, val outlets: List<Outlet> = listOf(), val costDescription: String? = null)

Port

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])

interface Port

Rating

abstract class Rating

RemainingArrivalMetricType

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])

enum RemainingArrivalMetricType : Enum<RemainingArrivalMetricType>

RouteManeuver

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])

interface RouteManeuver

RoutePlace

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])

data class RoutePlace( val id: String, val mapboxId: String?, val name: String, val coordinate: Point, val routablePoint: RoutablePoint?, val address: String?, val categories: List<String>, val evWaypoint: EvWaypoint?)

TripSummaryModel

class TripSummaryModel @RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX]) constructor( val traveledToRemainingRatio: Float, val legDistanceRemaining: String, val legTimeRemaining: String, val legArrivalTime: String, val preferredRemainingArrivalMetricType: RemainingArrivalMetricType, val isOffline: Boolean, val legStateOfCharge: Int? = null, val trafficGradientStops: List<Pair<Float, Color?>> = emptyList(), val waypointsData: List<WaypointData> = emptyList())

UxDisplayMetrics

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])

class UxDisplayMetrics

WaypointData

class WaypointData @RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX]) constructor(val iconBias: Float, val isChargingStation: Boolean)

Weather

class Weather @RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX]) constructor( val weatherNow: String, val weatherHigh: String, val weatherLow: String, @DrawableRes val iconResId: Int)

Represents the weather information.

Properties

FAVORITE_NAME_SEPARATOR

const val FAVORITE_NAME_SEPARATOR: String

Functions

customName

fun DestinationSearchResult.customName(): String?

fullName

fun DestinationSearchResult.fullName(): String

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])

fun RoutePlace.fullName(): String

originName

fun DestinationSearchResult.originName(): String

shouldRender

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])

fun ChargeData.shouldRender(): Boolean

toArrivalInformation

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])

fun EtaDistance?.toArrivalInformation( formatter: ArrivalInformationFormatter, arrivalStateOfCharge: Int? = null, returnStateOfCharge: Int? = null, isOffline: Boolean = false, arrivalCoordinate: Point? = null): ArrivalInformation

updateCustomName

fun DestinationSearchResult.updateCustomName(customName: String): DestinationSearchResult