MapboxScreen

object MapboxScreen

This object contains pre-defined screens and experiences that are provided by Mapbox. Each screen can be overridden with a screen of your choice.

Each Mapbox defined screen is prefixed with "MAPBOX_" to prevent any future collisions. For example, if you define a screen called "PICKUP", this library will never cause a conflict with your screen because it will use "MAPBOX_PICKUP". Please do not prefix your custom screens with "MAPBOX_" or else our library may add conflict upon upgrade.

See also

for more details on customizing your experience.

Types

Link copied to clipboard
annotation class Key

Properties

Link copied to clipboard
const val ACTIVE_GUIDANCE: String

Gives the user an ability to follow turn by turn directions to a destination.

Link copied to clipboard
const val ACTIVE_GUIDANCE_FEEDBACK: String

Give the user an ability to provide feedback from ACTIVE_GUIDANCE,

Link copied to clipboard
const val ARRIVAL: String

Shows the user a screen when they arrive at the destination.

Link copied to clipboard
const val FAVORITES: String

Gives the user the ability to select a personally favorite destination.

Link copied to clipboard
const val FAVORITES_FEEDBACK: String

Give the user an ability to provide feedback for FAVORITES.

Link copied to clipboard
const val FREE_DRIVE: String

Gives the user an ability to navigate without a specified route.

Link copied to clipboard
const val FREE_DRIVE_FEEDBACK: String

Gives the user an ability to provide feedback for FREE_DRIVE.

Link copied to clipboard
const val GEO_DEEPLINK: String

Gives the user an ability search for a destination with their voice.

Link copied to clipboard
const val GEO_DEEPLINK_FEEDBACK: String

Gives the user an ability to search for a destination with their voice.

Link copied to clipboard
const val NEEDS_LOCATION_PERMISSION: String

Provides the user instructions for enabling location permissions.

Link copied to clipboard
const val ROUTE_PREVIEW: String

Gives the user an ability to select a navigation route.

Link copied to clipboard
const val ROUTE_PREVIEW_FEEDBACK: String

Give the user an ability to provide feedback from ROUTE_PREVIEW.

Link copied to clipboard
const val SEARCH: String

Gives the user an ability to search for a destination.

Link copied to clipboard
const val SEARCH_FEEDBACK: String

Give the user an ability to provide feedback for SEARCH.

Link copied to clipboard
const val SETTINGS: String

Provides the user with a screen for changing app settings.