Citymapper SDK/com.citymapper.sdk.navigation

Package com.citymapper.sdk.navigation

Types

AlternativeRoute

data class AlternativeRoute

CitymapperNavigationTracking

class CitymapperNavigationTracking : NavigationController

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

NavigationController

interface NavigationController : RouteProgressSource<RouteProgress?>

PlanAlternateRoutesUseCase

interface PlanAlternateRoutesUseCase

RawProgressFacade

object RawProgressFacade

RouteProgressSource

interface RouteProgressSource<out Progress : RouteProgress?>

RouteUpdatesUseCase

interface RouteUpdatesUseCase

StartNavigationResult

sealed class StartNavigationResult

StartNavigationResultListener

fun interface StartNavigationResultListener

TrackingConfiguration

data class TrackingConfiguration @JvmOverloads constructor(enableOnDeviceLogging: Boolean, enableRemoteLogging: Boolean, simulation: SimulationConfig, foregroundServiceClass: Class<*>)

Creates an instance of TrackingConfiguration

VehicleLockState

sealed class VehicleLockState

Functions

startNavigation

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

suspend fun CitymapperNavigationTracking.startNavigation(route: Route, trackingConfiguration: TrackingConfiguration): StartNavigationResult

Suspending version of CitymapperNavigationTracking.startNavigation