|
| 1 | +package com.mapbox.navigation.core.lifecycle |
| 2 | + |
| 3 | +import androidx.lifecycle.DefaultLifecycleObserver |
| 4 | +import androidx.lifecycle.Lifecycle |
| 5 | +import androidx.lifecycle.LifecycleOwner |
| 6 | +import com.mapbox.navigation.core.MapboxNavigation |
| 7 | +import kotlin.properties.ReadOnlyProperty |
| 8 | +import kotlin.reflect.KProperty |
| 9 | + |
| 10 | +/** |
| 11 | + * Extension function to make it simple to create the [RequireMapboxNavigationProperty]. Below are |
| 12 | + * a couple examples of how you may use the delegate. |
| 13 | + * |
| 14 | + * Default can be used when [MapboxNavigationApp] is setup elsewhere. |
| 15 | + * ``` |
| 16 | + * val mapboxNavigation by requireMapboxNavigation() |
| 17 | + * ``` |
| 18 | + * |
| 19 | + * Initialize the [MapboxNavigationApp] when you are ready to use it |
| 20 | + * ``` |
| 21 | + * val mapboxNavigation by requireMapboxNavigation { |
| 22 | + * MapboxNavigationApp.setup(..) |
| 23 | + * } |
| 24 | + * ``` |
| 25 | + * |
| 26 | + * Register subscriptions and setup MapboxNavigationApp |
| 27 | + * ``` |
| 28 | + * private val mapboxNavigation by requireMapboxNavigation( |
| 29 | + * onResumedObserver = object : MapboxNavigationObserver { |
| 30 | + * override fun onAttached(mapboxNavigation: MapboxNavigation) { |
| 31 | + * mapboxNavigation.registerLocationObserver(locationObserver) |
| 32 | + * mapboxNavigation.registerRoutesObserver(routesObserver) |
| 33 | + * } |
| 34 | + * override fun onDetached(mapboxNavigation: MapboxNavigation) { |
| 35 | + * mapboxNavigation.unregisterLocationObserver(locationObserver) |
| 36 | + * mapboxNavigation.unregisterRoutesObserver(routesObserver) |
| 37 | + * } |
| 38 | + * } |
| 39 | + * ) { |
| 40 | + * MapboxNavigationApp.setup( |
| 41 | + * NavigationOptions.Builder(this) |
| 42 | + * .accessToken(accessToken) |
| 43 | + * .build() |
| 44 | + * ) |
| 45 | + * } |
| 46 | + * ``` |
| 47 | + * |
| 48 | + * @see [RequireMapboxNavigationProperty] for more details. |
| 49 | + */ |
| 50 | +fun requireMapboxNavigation( |
| 51 | + onCreatedObserver: MapboxNavigationObserver? = null, |
| 52 | + onStartedObserver: MapboxNavigationObserver? = null, |
| 53 | + onResumedObserver: MapboxNavigationObserver? = null, |
| 54 | + onInitialize: () -> Unit |
| 55 | +) = RequireMapboxNavigationProperty( |
| 56 | + onCreatedObserver = onCreatedObserver, |
| 57 | + onStartedObserver = onStartedObserver, |
| 58 | + onResumedObserver = onResumedObserver, |
| 59 | + onInitialize = onInitialize |
| 60 | +) |
| 61 | + |
| 62 | +/** |
| 63 | + * Creates a simple way to use the [MapboxNavigationApp] inside a [LifecycleOwner] and provides |
| 64 | + * access to [MapboxNavigation]. |
| 65 | + * |
| 66 | + * You can choose to call [MapboxNavigationApp.setup] in the [onInitialize]. You can also setup in |
| 67 | + * the onCreate calls, or any call that happens before this delegate is accessed. The delegate will |
| 68 | + * crash if the app is not setup and an attached has been created. |
| 69 | + * |
| 70 | + * You can use the observers parameter to setup any subscriptions. This is important because the |
| 71 | + * [MapboxNavigation] instance can be re-created with [MapboxNavigationApp.disable], or if all |
| 72 | + * [MapboxNavigationApp.attach] lifecycles are destroyed. |
| 73 | + * |
| 74 | + * @param onCreatedObserver to setup any subscriptions when the lifecycle [Lifecycle.State.CREATED] |
| 75 | + * @param onStartedObserver to setup any subscriptions when the lifecycle [Lifecycle.State.STARTED] |
| 76 | + * @param onResumedObserver to setup any subscriptions when the lifecycle [Lifecycle.State.RESUMED] |
| 77 | + * @param onInitialize called after the lifecycle has been attached |
| 78 | + */ |
| 79 | +class RequireMapboxNavigationProperty( |
| 80 | + private val onCreatedObserver: MapboxNavigationObserver? = null, |
| 81 | + private val onStartedObserver: MapboxNavigationObserver? = null, |
| 82 | + private val onResumedObserver: MapboxNavigationObserver? = null, |
| 83 | + private val onInitialize: (() -> Unit)? = null |
| 84 | +) : ReadOnlyProperty<LifecycleOwner, MapboxNavigation> { |
| 85 | + |
| 86 | + private lateinit var lifecycleOwner: LifecycleOwner |
| 87 | + |
| 88 | + private val lifecycleObserver = object : DefaultLifecycleObserver { |
| 89 | + override fun onCreate(owner: LifecycleOwner) { |
| 90 | + onCreatedObserver?.let { MapboxNavigationApp.registerObserver(it) } |
| 91 | + } |
| 92 | + |
| 93 | + override fun onDestroy(owner: LifecycleOwner) { |
| 94 | + onCreatedObserver?.let { MapboxNavigationApp.unregisterObserver(it) } |
| 95 | + } |
| 96 | + |
| 97 | + override fun onStart(owner: LifecycleOwner) { |
| 98 | + onStartedObserver?.let { MapboxNavigationApp.registerObserver(it) } |
| 99 | + } |
| 100 | + |
| 101 | + override fun onStop(owner: LifecycleOwner) { |
| 102 | + onStartedObserver?.let { MapboxNavigationApp.unregisterObserver(it) } |
| 103 | + } |
| 104 | + |
| 105 | + override fun onResume(owner: LifecycleOwner) { |
| 106 | + onResumedObserver?.let { MapboxNavigationApp.registerObserver(it) } |
| 107 | + } |
| 108 | + |
| 109 | + override fun onPause(owner: LifecycleOwner) { |
| 110 | + onResumedObserver?.let { MapboxNavigationApp.unregisterObserver(it) } |
| 111 | + } |
| 112 | + } |
| 113 | + |
| 114 | + override fun getValue(thisRef: LifecycleOwner, property: KProperty<*>): MapboxNavigation { |
| 115 | + if (!this::lifecycleOwner.isInitialized) { |
| 116 | + onInitialize?.invoke() |
| 117 | + this.lifecycleOwner = thisRef |
| 118 | + MapboxNavigationApp.attach(lifecycleOwner) |
| 119 | + lifecycleOwner.lifecycle.addObserver(lifecycleObserver) |
| 120 | + } |
| 121 | + val mapboxNavigation = MapboxNavigationApp.current() |
| 122 | + checkNotNull(mapboxNavigation) { |
| 123 | + "MapboxNavigation cannot be null. Ensure that MapboxNavigationApp is setup and an" + |
| 124 | + " attached lifecycle is at least CREATED." |
| 125 | + } |
| 126 | + return mapboxNavigation |
| 127 | + } |
| 128 | +} |
0 commit comments