Citymapper SDK/com.citymapper.sdk.navigation/NavigableRoute

NavigableRoute

class NavigableRoute constructor(seedRoute: Route, globalProgressSource: RouteProgressSource<RouteProgress?>, startNavigation: (Route, StartNavigationResultListener) -> Unit, updateActiveRoute: (Route) -> Unit, routeUpdatesUseCase: RouteUpdatesUseCase, alternateRoutesPlanner: PlanAlternateRoutesUseCase) : RouteProgressSource<RouteProgress>

Functions

addRouteUpdatesLifecycle

fun addRouteUpdatesLifecycle(lifecycle: Lifecycle)

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

open override fun hashCode(): Int

registerRouteProgressListener

open fun registerRouteProgressListener(listener: RouteProgressListener<RouteProgress?>): Disposable

removeRouteUpdatesLifecycle

fun removeRouteUpdatesLifecycle(lifecycle: Lifecycle)

startNavigation

@RequiresPermission(value = "android.permission.ACCESS_FINE_LOCATION")

fun startNavigation(startNavigationResultListener: StartNavigationResultListener)

updateAlternativeRoutes

suspend fun updateAlternativeRoutes()

Trigger an update to the list of alternativeRoutes

Properties

activeRouteProgress

open override val activeRouteProgress: Flow<RouteProgress>

alternativeRoutes

val alternativeRoutes: StateFlow<List<AlternativeRoute>>

Alternative options for the current Route, e.g. using different Route.profiles. Note that at present, these are only updated when calling updateAlternativeRoutes