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

A builder of TravelEstimate.

Constants

const Long

A value used to represent an unknown remaining amount of time.

Public functions

Boolean
equals(other: Any?)
DateTimeWithZone?

Returns the arrival time until at the destination or null if not set.

Distance?

Returns the remaining Distance until arriving at the destination, or null if not set.

CarColor?

Returns the color of the remaining distance text or null if not set.

CarColor?

Returns the color of the remaining time text or null if not set.

Long

Returns the remaining time until arriving at the destination, in seconds.

CarIcon?

Returns the trip icon or null if not set.

CarText?

Returns the trip text or null if not set.

Int
String

Constants

REMAINING_TIME_UNKNOWN

Added in 1.0.0
const val REMAINING_TIME_UNKNOWN = -1: Long

A value used to represent an unknown remaining amount of time.

Public functions

equals

fun equals(other: Any?): Boolean

getArrivalTimeAtDestination

Added in 1.0.0
fun getArrivalTimeAtDestination(): DateTimeWithZone?

Returns the arrival time until at the destination or null if not set.

See also
Builder

getRemainingDistance

Added in 1.0.0
fun getRemainingDistance(): Distance?

Returns the remaining Distance until arriving at the destination, or null if not set.

See also
Builder

getRemainingDistanceColor

Added in 1.0.0
fun getRemainingDistanceColor(): CarColor?

Returns the color of the remaining distance text or null if not set.

getRemainingTimeColor

Added in 1.0.0
fun getRemainingTimeColor(): CarColor?

Returns the color of the remaining time text or null if not set.

getRemainingTimeSeconds

Added in 1.0.0
fun getRemainingTimeSeconds(): Long

Returns the remaining time until arriving at the destination, in seconds.

getTripIcon

Added in 1.3.0
@RequiresCarApi(value = 5)
fun getTripIcon(): CarIcon?

Returns the trip icon or null if not set.

See also
setTripIcon

getTripText

Added in 1.3.0
@RequiresCarApi(value = 5)
fun getTripText(): CarText?

Returns the trip text or null if not set.

See also
setTripText

hashCode

fun hashCode(): Int

toString

fun toString(): String