TravelEstimate.Builder

Builder(
    remainingDistance: Distance,
    arrivalTimeAtDestination: DateTimeWithZone
)

Constructs a new builder of TravelEstimate.

@RequiresApi(value = 26)
Builder(
    remainingDistance: Distance,
    arrivalTimeAtDestination: ZonedDateTime
)

Constructs a new builder of TravelEstimate.

fun build(): TravelEstimate

Constructs the TravelEstimate defined by this builder.

fun setRemainingDistanceColor(remainingDistanceColor: CarColor): TravelEstimate.Builder

Sets the color of the remaining distance text.

Depending on contrast requirements, capabilities of the vehicle screens, or other factors, the color may be ignored by the host or overridden by the vehicle system.

If not set, DEFAULT will be used.

Custom colors created with createCustom are not supported.

@RequiresApi(value = 26)
fun setRemainingTime(remainingTime: Duration): TravelEstimate.Builder

Sets the estimated time remaining until arriving at the destination.

If not set, REMAINING_TIME_UNKNOWN will be used.

fun setRemainingTimeColor(remainingTimeColor: CarColor): TravelEstimate.Builder

Sets the color of the remaining time text.

Depending on contrast requirements, capabilities of the vehicle screens, or other factors, the color may be ignored by the host or overridden by the vehicle system.

If not set, DEFAULT will be used.

Custom colors created with createCustom are not supported.

fun setRemainingTimeSeconds(remainingTimeSeconds: @IntRange(from = "-1") Long): TravelEstimate.Builder

Sets the estimated time remaining until arriving at the destination, in seconds.

If not set, REMAINING_TIME_UNKNOWN will be used.

Note that REMAINING_TIME_UNKNOWN may not be supported depending on where the TravelEstimate is used. See the documentation of where TravelEstimate is used for any restrictions that might apply.

@RequiresCarApi(value = 5)
fun setTripIcon(tripIcon: CarIcon): TravelEstimate.Builder

Sets a CarIcon that is associated with the current TravelEstimate

See CarIcon for more details related to providing icon and image resources that work with different car screen pixel densities.

@RequiresCarApi(value = 5)
fun setTripText(tripText: CarText): TravelEstimate.Builder

Sets the trip text.

A text that provides additional information about this TravelEstimate, such as drop off/pick up information, and battery level, that should be displayed on the screen alongside the remaining distance and time.

For example "Pick up Alice", "Drop off Susan", or "Battery Level is Low".