OnboardRouterOptions

class OnboardRouterOptions

Defines options for on-board router. These options enable a feature also known as Free Drive. This allows the navigator to map-match your location onto the road network without a route.

Parameters

tilesUri

tiles endpoint

tilesVersion

version of tiles. If not specified (empty), latest version is used

filePath

used for storing road network tiles

keepOlderTilesVersions

true if older version tiles must be kept, false if not. Note that this only works if tilesVersion is empty

minDaysBetweenServerAndLocalTilesVersion

is the minimum time in days between local version of tiles and latest on the server to consider using the latest version of routing tiles from the server. As updating tiles frequently consumes considerably energy and bandwidth. Note that this only works if tilesVersion is empty.

Types

Builder

class Builder

Builder for OnboardRouterOptions.

Functions

equals

open operator override fun equals(other: Any?): Boolean

Regenerate whenever a change is made

hashCode

open override fun hashCode(): Int

Regenerate whenever a change is made

toBuilder

fun toBuilder(): OnboardRouterOptions.Builder

toString

open override fun toString(): String

Returns a string representation of the object.

Properties

filePath

val filePath: String?

used for storing road network tiles

keepOlderTilesVersions

val keepOlderTilesVersions: Boolean

true if older version tiles must be kept, false if not.

minDaysBetweenServerAndLocalTilesVersion

val minDaysBetweenServerAndLocalTilesVersion: Int

is the minimum time in days between local version of tiles and latest on the server to consider using the latest version of routing tiles from the server.

tilesUri

val tilesUri: URI

tiles endpoint

tilesVersion

val tilesVersion: String

version of tiles.