Route

open class Route : BaseNativeParcelable

Collection of maneuvers and roadElements connecting two or more waypoints. Waypoints may be thought of as the input to a route calculation whereas maneuvers are the results of calculating a route.

Types

RoadElementsCallback

interface RoadElementsCallback

Functions

describeContents

abstract fun describeContents(): Int

open fun describeContents(): Int

For documentation, see android.os.Parcelable.

deserializeFromFullJSON

@Nullable()

open fun deserializeFromFullJSON(@NonNull() json: String): Route

Deserialize route from json generated with serializeToFullJSON.

equals

open fun equals(o: Any): Boolean

getBoundingBox

@NonNull()

open fun getBoundingBox(): GeoBoundingBox

The smallest GeoBoundingBox that contains the entire route.

getDestination

@NonNull()

open fun getDestination(): Waypoint

Returns the destination waypoint of the route

getEVProfile

@Nullable()

open fun getEVProfile(): EVProfile

Returns EV profile used for computing this route or null if this is not EV route

getManeuvers

@NonNull()

open fun getManeuvers(): List<RouteManeuver>

Returns an array of directions for current route object from start.Note: This array doesn't change while navigating.

getPolylinesFromRouteSegments

@Nullable()

open fun getPolylinesFromRouteSegments(routeSegments: List<RouteSegment>): List<GeoPolyline>

Returns list of GeoPolylines representing route segments

getRoadElements

open fun getRoadElements(@NonNull() callback: Route.RoadElementsCallback)

Returns a list of RoadElement objects for current route object from start.

open fun getRoadElements(@NonNull() callback: Route.RoadElementsCallback, @Nullable() executor: Executor)

Returns a list of RoadElement objects for current route object from start.

getRouteGeometry

@Nullable()

open fun getRouteGeometry(): List<GeoCoordinates>

Returns list of coordinates representing route geometry

getRouteId

open fun getRouteId(): Int

Returns the unique id identifies the route.

getRouteInfo

@NonNull()

open fun getRouteInfo(): RouteInfo

Returns basic route info.

getRouteViolatedAvoidOptions

open fun getRouteViolatedAvoidOptions(): RouteViolatedAvoidOptions

getRoutingOptions

@NonNull()

open fun getRoutingOptions(): RoutingOptions

Returns options used for computing this route.

getStart

@NonNull()

open fun getStart(): Waypoint

Returns the starting waypoint of the route

getTransitCountries

@NonNull()

open fun getTransitCountries(): List<String>

Returns list of countries route is passing by

getWaypoints

@NonNull()

open fun getWaypoints(): List<Waypoint>

List of Waypoints on the route including starting point and destination.

hashCode

open fun hashCode(): Int

isValidParcelable

open fun isValidParcelable(): Boolean

If object after recreate from parcel contains all of reference like original object method returntrue.

serializeToBriefJSON

open fun serializeToBriefJSON(): String

Serialize the route to a JSON string.

serializeToFullJSON

open fun serializeToFullJSON(): String

Serialize the route to a JSON string.

writeToParcel

abstract fun writeToParcel(p: Parcel, p1: Int)

open fun writeToParcel(dest: Parcel, flags: Int)

For documentation, see android.os.Parcelable.writeToParcel().

Properties

CREATOR

val CREATOR: Parcelable.Creator<Route>