Citymapper SDK/com.citymapper.sdk.directions/CitymapperDirections

CitymapperDirections

class CitymapperDirections

Types

Companion

object Companion

Functions

loadRoute

suspend fun loadRoute(handle: StoredRouteHandle): Route?

fun loadRoute(handle: StoredRouteHandle, callback: (Route?) -> Unit)

Retrieve a route previously stored with storeRoute. Only the previous 1 route is currently available

planBikeHireRoute

fun planBikeHireRoute(start: Coords, end: Coords, brandId: String, profiles: List<Profile> = listOf(Profile.Regular)): ApiCall<DirectionsResults, DirectionsError>

@JvmOverloads

fun planBikeHireRoute(start: Coords, end: Coords, brandId: String, rideStartLocation: Coords? = null, profiles: List<Profile> = listOf(Profile.Regular)): ApiCall<DirectionsResults, DirectionsError>

planBikeRoutes

@JvmOverloads

fun planBikeRoutes(start: Coords, end: Coords, profiles: List<Profile> = listOf(Profile.Regular)): ApiCall<DirectionsResults, DirectionsError>

planMotorscooterHireRoute

@JvmOverloads

fun planMotorscooterHireRoute(start: Coords, end: Coords, brandId: String, rideStartLocation: Coords? = null): ApiCall<DirectionsResults, DirectionsError>

planScooterHireRoute

@JvmOverloads

fun planScooterHireRoute(start: Coords, end: Coords, brandId: String, rideStartLocation: Coords? = null): ApiCall<DirectionsResults, DirectionsError>

planScooterRoute

fun planScooterRoute(start: Coords, end: Coords): ApiCall<DirectionsResults, DirectionsError>

planTransitRoutes

@JvmOverloads

fun planTransitRoutes(start: Coords, end: Coords, time: Date? = null, timeType: TimeType? = null): ApiCall<DirectionsResults, DirectionsError>

planWalkRoutes

@JvmOverloads

fun planWalkRoutes(start: Coords, end: Coords, profiles: List<Profile> = listOf(Profile.Fast)): ApiCall<DirectionsResults, DirectionsError>

storeRoute

fun storeRoute(route: Route): StoredRouteHandle

Store a Route for later retrieval. The Route will be (asynchronously) persisted to disk so can be retrieved after process death

updatesForRoute

fun updatesForRoute(route: Route, lifecycle: Lifecycle): StateFlow<Route>

updatesForRoutes

fun updatesForRoutes(routes: List<Route>, lifecycle: Lifecycle): StateFlow<List<Route>>