Trip

Artifact: androidx.car.app:app

View Source

Added in 1.0.0

---

Kotlin |Java

@CarProtocol
public final 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:

• The current road description get from getCue of the current Step, which gets from the first element of getSteps
• The remaining distance of the current road get from getRemainingDistance of the first element of getStepTravelEstimates
• The turn icon get from getIcon from the Maneuver of the current Step

Summary

Nested types
public final class Trip.Builder A builder of Trip.

Public methods
boolean	equals(@Nullable Object other)
@Nullable CarText	getCurrentRoad() Returns the text that describes the current road.
@NonNull List<TravelEstimate>	getDestinationTravelEstimates() Returns the list of TravelEstimates for the Destinations in the trip.
@NonNull List<Destination>	getDestinations() Returns the list of destinations for this trip.
@NonNull List<TravelEstimate>	getStepTravelEstimates() Returns the list of TravelEstimates for the Steps in the trip.
@NonNull List<Step>	getSteps() Returns the list of steps for the trip.
int	hashCode()
boolean	isLoading() Returns whether the trip is in a loading state.
@NonNull String	toString()

Public methods

equals

public boolean equals(@Nullable Object other)

getCurrentRoad

Added in 1.0.0

public @Nullable CarText getCurrentRoad()

Returns the text that describes the current road.

See also
setCurrentRoad

getDestinationTravelEstimates

Added in 1.0.0

public @NonNull List<TravelEstimate> getDestinationTravelEstimates()

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

See also
addDestination

getDestinations

Added in 1.0.0

public @NonNull List<Destination> getDestinations()

Returns the list of destinations for this trip.

See also
addDestination

getStepTravelEstimates

Added in 1.0.0

public @NonNull List<TravelEstimate> getStepTravelEstimates()

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

See also
addDestination

getSteps

Added in 1.0.0

public @NonNull List<Step> getSteps()

Returns the list of steps for the trip.

See also
addStep

hashCode

public int hashCode()

isLoading

Added in 1.0.0

public boolean isLoading()

Returns whether the trip is in a loading state.

See also
setLoading

toString

public @NonNull String toString()