MapboxNavigationApp

object MapboxNavigationApp

Manages a default lifecycle for MapboxNavigation.

Call MapboxNavigationApp.setup to specify your NavigationOptions.
Register and unregister your MapboxNavigationObserver instances with MapboxNavigationApp.registerObserver and MapboxNavigationApp.unregisterObserver.
Attach and detach LifecycleOwners to create instances of MapboxNavigation.

Examples

Register and unregister individual LifecycleOwners. Below is an example of creating a single activity that uses MapboxNavigation.

class MyActivity : ComponentActivity() {
  override fun onCreate() {
    MapboxNavigationApp
      .setup(navigationOptions)
      .attach(this)
  }
  override fun onResume() {
    MapboxNavigationApp
      .registerObserver(locationObserver)
  }
  override fun onPause() {
    MapboxNavigationApp
      .unregisterObserver(locationObserver)
  }
}

Alternatively, you can enable an entire application by attaching all activities. This will make a MapboxNavigation instance available to any activity or fragment.

class MyApplication : Application() {
  override fun onCreate() {
    MapboxNavigationApp.setup(this)
      .attachAllActivities()
      .registerObserver(locationObserver)
  }
}

Functions

attach

androidJvm

fun attach(lifecycleOwner: LifecycleOwner): MapboxNavigationApp

Individually attach a lifecycle onto the MapboxNavigationApp.

attachAllActivities

androidJvm

fun attachAllActivities(application: Application): MapboxNavigationApp

Detect when any Activity is in the foreground.

current

androidJvm

fun current(): MapboxNavigation?

MapboxNavigation has functions that do not require observation streams.

detach

androidJvm

fun detach(lifecycleOwner: LifecycleOwner): MapboxNavigationApp

Individually detach lifecycles from MapboxNavigationApp.

disable

androidJvm

fun disable(): MapboxNavigationApp

Optional function to detach all observers and disable MapboxNavigation from being created.

equals

androidJvm

open operator fun equals(other: Any?): Boolean

getObserver

androidJvm

fun <T : MapboxNavigationObserver> getObserver(kClass: KClass<T>): T

Provides access to any registered observer instance.

hashCode

androidJvm

open fun hashCode(): Int

isSetup

androidJvm

fun isSetup(): Boolean

Indicates whether the MapboxNavigationApp has been setup.

registerObserver

androidJvm

fun registerObserver(mapboxNavigationObserver: MapboxNavigationObserver): MapboxNavigationApp

Register an observer to receive the MapboxNavigation instance.

setup

androidJvm

fun setup(navigationOptions: NavigationOptions): MapboxNavigationApp

Call MapboxNavigationApp.setup to provide the application with NavigationOptions.

fun setup(navigationOptionsProvider: NavigationOptionsProvider): MapboxNavigationApp

Call MapboxNavigationApp.setup to provide the application with NavigationOptionsProvider.

toString

androidJvm

open fun toString(): String

unregisterObserver

androidJvm

fun unregisterObserver(mapboxNavigationObserver: MapboxNavigationObserver): MapboxNavigationApp

Unregister the observer that was registered through registerObserver.

Properties

lifecycleOwner

androidJvm

val lifecycleOwner: LifecycleOwner

Get the lifecycle of the car and app.