RouteRefreshOptions

class RouteRefreshOptions

The options available for refreshing the current primary NavigationRoute, as well as the alternatives. Each refresh will update:

  • RouteLeg.annotation

  • RouteLeg.incidents

  • RouteLeg.closures

  • duration fields

This includes traffic congestion and estimated travel time. Make sure that RouteOptions.enableRefresh is true to take advantage of this feature.

In case of a route refresh failing for 3 * intervalMillis (default is 15 min), expired incidents and congestion annotations will be removed from the route in order to avoid presenting non-critical, outdated information. Closures are not cleared automatically, only upon information from a successful refresh.

Parameters

intervalMillis

The refresh interval in milliseconds, default is 5 min.

Types

Link copied to clipboard
class Builder

Functions

Link copied to clipboard
open operator override fun equals(other: Any?): Boolean

Regenerate whenever a change is made

Link copied to clipboard
open override fun hashCode(): Int

Regenerate whenever a change is made

Link copied to clipboard
fun toBuilder(): RouteRefreshOptions.Builder
Link copied to clipboard
open override fun toString(): String

Returns a string representation of the object.

Properties

Link copied to clipboard
val intervalMillis: Long