navigation-ux-nav-manager-api/com.mapbox.dash.sdk.nav.manager.api.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".

Category

class Category(val name: String) : SearchItem

A category like "restaurant" or "supermarket".

NavigationState

interface NavigationState

Represents the current state of the navigation.

NavigationStateActiveGuidance

class NavigationStateActiveGuidance(val waypoints: List<SearchResult>) : NavigationState

The navigation app is in the active guidance mode.

NavigationStateFreeDrive

class NavigationStateFreeDrive(val previewWaypoints: List<SearchResult>) : NavigationState

The navigation app is in the free drive mode.

Point

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

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

SearchAlongTheRouteOptions

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

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

SearchItem

interface 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)

Search options, used for forward geocoding.

SearchResult

class SearchResult(val id: String, val coordinate: Point, val address: Address?, val name: String, val customName: String?, val type: String, val categories: List<String>?, val description: String?, val distanceMeters: Double?, val etaMinutes: Double?, val metadata: Map<String, String>?) : 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.

SearchResultType

object SearchResultType

Defines type of search result.