navigation-ux-ipc-client-core/com.mapbox.dash.sdk.ipc.client.core.model

Package-level declarations

Types

class Address(val houseNumber: String? = null, val street: String? = null, val neighborhood: String? = null, val locality: String? = null, val postcode: String? = null, val place: String? = null, val district: String? = null, val region: String? = null, val country: String? = null)

Represents a physical address with various optional components.

BoundingBox

class BoundingBox(val southwest: Point, val northeast: Point)

A bounding box is a rectangular area of a map.

Brand

class Brand(val name: String) : SearchItem

A brand like "McDonald's" or "Burger King".

CameraBounds

class CameraBounds

Holds information about camera bounds, i.e. camera limitations.

CameraTrackingMode

object CameraTrackingMode

Defines type of map camera overview modes.

Category

class Category(val name: String, val canonicalName: String) : SearchItem

A category like "restaurant" or "supermarket".

CategorySearchOptions

class CategorySearchOptions(val proximity: Point? = null, val boundingBox: BoundingBox? = null)

Search options, used for category search.

DayOfWeekTime

class DayOfWeekTime(val day: Int, val hour: Int, val minute: Int)

Represents a specific time within a specific day of a week.

ETCRoadType

object ETCRoadType

EvChargerConnector

class EvChargerConnector

Represents a connector at a charging station.

EvStationMetadata

class EvStationMetadata

Represents metadata for a single EV charging station.

EvWaypointMetadata

class EvWaypointMetadata

A metadata about an EV-waypoint, which is a part of a route defined by NavigationState.

FavoritePlace

class FavoritePlace(val place: SearchResult, val type: String)

Represents a user-defined favorite place.

FavoriteType

object FavoriteType

Represents different types of user-defined favorite locations.

ForwardOptions

class ForwardOptions(val proximity: Point? = null, val boundingBox: BoundingBox? = null, val countries: List<String>? = null)

Options, required to call com.mapbox.dash.sdk.ipc.client.core.NavManagerService.forward.

HoursOfOperation

abstract class HoursOfOperation

Represents hours of operations of a POI (SearchResult).

LocationMatcherResult

class LocationMatcherResult(val location: MapMatchedLocation, val etcRoadType: Int, val speed3D: Float, val altitudeMeanSeaLevel: Float)

Represents the result of MapMatching.

MapDisplayOptions

class MapDisplayOptions(val trafficVisibilityType: String, val satelliteMode: Boolean)

Configuration of how the map will look.

MapMatchedLocation

class MapMatchedLocation(val latitude: Double, val longitude: Double, val heading: Float)

Class representing a map-matched location.

MapTrafficVisibilityType

object MapTrafficVisibilityType

Defines the traffic visibility on the map.

NavigationState

abstract class NavigationState

Represents the current state of the navigation.

NavigationStateActiveGuidance

class NavigationStateActiveGuidance(val waypoints: List<SearchResult>, val evWaypointsMetadata: Map<String, EvWaypointMetadata>) : NavigationState

The navigation app is in the active guidance mode.

NavigationStateFreeDrive

class NavigationStateFreeDrive(val previewWaypoints: List<SearchResult>, val evWaypointsMetadata: Map<String, EvWaypointMetadata>) : NavigationState

The navigation app is in the free drive mode.

OperatingInterval

class OperatingInterval(val open: DayOfWeekTime, val closed: DayOfWeekTime)

Represents times of a day when a POI (SearchResult) is opened and closed.

PlaceDetailsUIState

class PlaceDetailsUIState

The state of the Place Details UI.

Point

class Point(val latitude: Double, val longitude: Double)

A point is a geospatial feature defined by one pair of latitude and longitude coordinates.

Route

class Route

Represents a route option during navigation. Contains route information including identification, name, distance, and estimated time.

RouteOptions

class RouteOptions(val avoidHighways: Boolean, val avoidTolls: Boolean, val avoidFerries: Boolean, val avoidUnpavedRoads: Boolean, val includeHov2: Boolean, val includeHov3: Boolean, val suppressVoiceInstructionLocalNames: Boolean)

Configuration options for route calculation.

SearchAlongTheRouteOptions

class SearchAlongTheRouteOptions(val deviationTime: Duration = 3.minutes)

Options to perform a SAR (search along the route).

SearchItem

abstract class SearchItem

Item found by a search with an instance of NavManagerService.

SearchOptions

class SearchOptions(val proximity: Point? = null, val boundingBox: BoundingBox? = null, val countries: List<String>? = null)

Options, required to call com.mapbox.dash.sdk.ipc.client.core.NavManagerService.search.

SearchResult

class SearchResult(val id: String, val coordinate: Point, val address: Address?, val name: String, val customName: String?, val type: String, val categoryIds: List<String>?, val description: String?, val distanceMeters: Double?, val isOffline: Boolean, val metadata: SearchResultMetadata?, val evStationId: String? = null, val isTransient: Boolean) : SearchItem

Represents a place on a map that the user can navigate to. Must not necessary be instantiated by Mapbox, can also be created on the client side to convert 3rd-party search results into Mapbox format to then navigate to them.

SearchResultMetadata

class SearchResultMetadata(val reviewCount: Int? = null, val phone: String? = null, val website: String? = null, val rating: Float? = null, val description: String? = null, val openHours: HoursOfOperation? = null)

Additional metadata for a SearchResult.

SearchResultRouteInfo

class SearchResultRouteInfo

Represents a search result enhanced with route metrics information.

SearchResultType

object SearchResultType

Defines type of search result.

SearchUIState

class SearchUIState

The state of the search results UI.

SlowTrafficInfo

class SlowTrafficInfo

Slow traffic notification information.

UiModeSettings

object UiModeSettings

Holds available UiModeSettings types.

UIOptions

class UIOptions(val uiModeSettings: String)

Configuration of how the UI will look.