NavigationRoute

class NavigationRoute

Wraps a route object used across the Navigation SDK features.

Parameters

directionsResponse

the original response that returned this route object.

routeIndex

the index of the route that this wrapper tracks from the collection of routes returned in the original response.

routeOptions

options used to generate the directionsResponse

Types

Companion

androidJvm

object Companion

Functions

equals

androidJvm

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

Indicates whether some other object is "equal to" this one.

hashCode

androidJvm

open override fun hashCode(): Int

Returns a hash code value for the object.

toString

androidJvm

open override fun toString(): String

Returns a string representation of the object.

Properties

directionsResponse

androidJvm

val directionsResponse: DirectionsResponse

the original response that returned this route object.

directionsRoute

androidJvm

val directionsRoute: DirectionsRoute

DirectionsRoute that this NavigationRoute represents.

androidJvm

val id: String

Unique local identifier of the route instance.

origin

androidJvm

val origin: RouterOrigin

Describes which router type generated the route.

routeIndex

androidJvm

val routeIndex: Int

the index of the route that this wrapper tracks from the collection of routes returned in the original response.

routeOptions

androidJvm

val routeOptions: RouteOptions

options used to generate the directionsResponse

Extensions

exclusionViolations

androidJvm

fun NavigationRoute.exclusionViolations(): List<ExclusionViolation>

Returns all violated exclusions for this route.