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.

Functions

describeContents

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.

destroy

open fun destroy()

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

getManeuvers

@NonNull

open fun getManeuvers(): List<RouteManeuver>

Returns an array of directions for current route object from start.

getNativeRouteCountForHandle

open fun getNativeRouteCountForHandle(): Int

getPolylinesFromRouteSegments

@Nullable

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

Returns list of GeoPolylines representing route segments

getRouteElements

open fun getRouteElements(@NonNull listener: RouteElementsListener)

open fun getRouteElements(@NonNull listener: RouteElementsListener, @Nullable executor: Executor)

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

getRouteGeometry

@Nullable

@Deprecated

~~open~~ ~~fun~~ ~~getRouteGeometry~~(): List<GeoCoordinates>

Returns list of coordinates representing route geometry

open fun getRouteGeometry(withAltitude: Boolean, @NonNull listener: GeometryListener)

open fun getRouteGeometry(withAltitude: Boolean, @NonNull listener: GeometryListener, @Nullable executor: Executor)

Returns geometry with altitude of route.

getRouteId

open fun getRouteId(): Int

Returns the unique id identifies the route.

getRouteInfo

@NonNull

open fun getRouteInfo(): RouteInfo

Returns basic route info.

getRouteRequest

@NonNull

open fun getRouteRequest(): RouteRequest

Returns options used for computing this route.

getRouteViolatedAvoidOptions

open fun getRouteViolatedAvoidOptions(): RouteViolatedAvoidOptions

getRouteWarnings

open fun getRouteWarnings(@NonNull listener: RouteWarningsListener)

open fun getRouteWarnings(@NonNull listener: RouteWarningsListener, @Nullable executor: Executor)

Returns a list of RouteWarning warnings, which occurred during route calculation.

getStart

@NonNull

open fun getStart(): Waypoint

Returns the starting waypoint of the route

getTransitCountries

@NonNull

@Deprecated

~~open~~ ~~fun~~ ~~getTransitCountries~~(): List<String>

Returns list of countries route is passing by

getTransitCountriesInfo

open fun getTransitCountriesInfo(@NonNull listener: TransitCountriesInfoListener)

open fun getTransitCountriesInfo(@NonNull listener: TransitCountriesInfoListener, @Nullable executor: Executor)

Retrieves list of countries route is passing by with regions, if available

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 return true.

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

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

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

Properties

CREATOR

val CREATOR: Parcelable.Creator<Route>