Trip

@CarProtocol
class Trip


Represents information about a trip including destinations, steps, and travel estimates.

This information data may be displayed in different places in the car such as the instrument cluster screens, heads-up display and floating navigation bar.

Floating navigation bar can show current navigating info in three templates including MapTemplate, RoutePreviewNavigationTemplate and PlaceListNavigationTemplate. The navigating steps can be added with the use of addStep. There are three navigation info showing in the floating nav bar including:

Summary

Nested types

A builder of Trip.

Public functions

Boolean
equals(other: Any?)
CarText?

Returns the text that describes the current road.

(Mutable)List<TravelEstimate!>

Returns the list of TravelEstimates for the Destinations in the trip.

(Mutable)List<Destination!>

Returns the list of destinations for this trip.

(Mutable)List<TravelEstimate!>

Returns the list of TravelEstimates for the Steps in the trip.

(Mutable)List<Step!>

Returns the list of steps for the trip.

Int
Boolean

Returns whether the trip is in a loading state.

String

Public functions

equals

Added in 1.4.0-rc02
fun equals(other: Any?): Boolean

getCurrentRoad

Added in 1.0.0
fun getCurrentRoad(): CarText?

Returns the text that describes the current road.

See also
setCurrentRoad

getDestinationTravelEstimates

Added in 1.0.0
fun getDestinationTravelEstimates(): (Mutable)List<TravelEstimate!>

Returns the list of TravelEstimates for the Destinations in the trip.

See also
addDestination

getDestinations

Added in 1.0.0
fun getDestinations(): (Mutable)List<Destination!>

Returns the list of destinations for this trip.

See also
addDestination

getStepTravelEstimates

Added in 1.0.0
fun getStepTravelEstimates(): (Mutable)List<TravelEstimate!>

Returns the list of TravelEstimates for the Steps in the trip.

See also
addDestination

getSteps

Added in 1.0.0
fun getSteps(): (Mutable)List<Step!>

Returns the list of steps for the trip.

See also
addStep

hashCode

Added in 1.4.0-rc02
fun hashCode(): Int

isLoading

Added in 1.0.0
fun isLoading(): Boolean

Returns whether the trip is in a loading state.

See also
setLoading

toString

Added in 1.4.0-rc02
fun toString(): String