TravelEstimate
@CarProtocol
class TravelEstimate
Represents the travel estimates to a destination of a trip or for a trip segment, including the remaining time and distance to the destination.
Summary
Nested types |
|---|
class TravelEstimate.BuilderA builder of |
Constants |
|
|---|---|
const Long |
A value used to represent an unknown remaining amount of time. |
Public functions |
|
|---|---|
Boolean |
|
DateTimeWithZone? |
Returns the arrival time until at the destination or |
Distance? |
Returns the remaining |
CarColor? |
Returns the color of the remaining distance text or |
CarColor? |
Returns the color of the remaining time text or |
Long |
Returns the remaining time until arriving at the destination, in seconds. |
CarIcon? |
@RequiresCarApi(value = 5)Returns the trip icon or |
CarText? |
@RequiresCarApi(value = 5)Returns the trip text or |
Int |
hashCode() |
String |
toString() |
Constants
REMAINING_TIME_UNKNOWN
const val REMAINING_TIME_UNKNOWN = -1: Long
A value used to represent an unknown remaining amount of time.
Public functions
getArrivalTimeAtDestination
fun getArrivalTimeAtDestination(): DateTimeWithZone?
Returns the arrival time until at the destination or null if not set.
| See also | |
|---|---|
Builder |
getRemainingDistance
fun getRemainingDistance(): Distance?
Returns the remaining Distance until arriving at the destination, or null if not set.
| See also | |
|---|---|
Builder |
getRemainingDistanceColor
fun getRemainingDistanceColor(): CarColor?
Returns the color of the remaining distance text or null if not set.
| See also | |
|---|---|
setRemainingDistanceColor |
getRemainingTimeColor
fun getRemainingTimeColor(): CarColor?
Returns the color of the remaining time text or null if not set.
| See also | |
|---|---|
setRemainingTimeColor |
getRemainingTimeSeconds
fun getRemainingTimeSeconds(): Long
Returns the remaining time until arriving at the destination, in seconds.
| See also | |
|---|---|
setRemainingTimeSeconds |
getTripIcon
@RequiresCarApi(value = 5)
fun getTripIcon(): CarIcon?
Returns the trip icon or null if not set.
| See also | |
|---|---|
setTripIcon |
getTripText
@RequiresCarApi(value = 5)
fun getTripText(): CarText?
Returns the trip text or null if not set.
| See also | |
|---|---|
setTripText |