Package-level declarations
Types
Link copied to clipboard
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.
Link copied to clipboard
A bounding box is a rectangular area of a map.
Link copied to clipboard
A brand like "McDonald's" or "Burger King".
Link copied to clipboard
A category like "restaurant" or "supermarket".
Link copied to clipboard
interface NavigationState
Represents the current state of the navigation.
Link copied to clipboard
The navigation app is in the active guidance mode.
Link copied to clipboard
The navigation app is in the free drive mode.
Link copied to clipboard
Options to perform a SAR (search along the route).
Link copied to clipboard
interface SearchItem
Item found by a search with an instance of NavManagerService.
Link copied to clipboard
class SearchOptions(val proximity: Point? = null, val boundingBox: BoundingBox? = null, val countries: List<String>? = null)
Search options, used for forward geocoding.
Link copied to clipboard
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.
Link copied to clipboard
object SearchResultType
Defines type of search result.