RoutingTilesOptions

class RoutingTilesOptions

Defines options for routing tiles endpoint and storage configuration.

Routing tiles are stored on-device and used for map-matching (enhanced location production), offline routing, Electronic Horizon generation, and other.

Parameters

tilesBaseUri

scheme and host, for example "https://api.mapbox.com". If empty, the navigator works in the fallback mode all the time (route line following; no full map-matching; no map-matching in free drive).

tilesDataset

string built out of <account>[.<graph>] variables. Account can be mapbox for default datasets or your username for other. Graph can be left blank if you don't target any custom datasets.

tilesProfile

profile of the dataset. One of (driving|driving-traffic|walking|cycling|truck).

tilesVersion

version of tiles, chosen automatically if empty

filePath

used for persistent configuration and history files storing.

tileStore

tile store instance. It manages downloads and storage for requests to tile-related API endpoints. For offline/predictive-caching use cases this instance should be the same that is passed to map resource options. When creating the TileStore make sure to call TileStore.setOption with TileStoreOptions.MAPBOX_ACCESS_TOKEN and your token. By default (if null is provided here), the TileStore will be created with a filePath and NavigationOptions.accessToken.

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

Link copied to clipboard
class Builder

Builder for RoutingTilesOptions. You must choose a filePath for this to be built successfully.

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(): RoutingTilesOptions.Builder
Link copied to clipboard
open override fun toString(): String

Returns a string representation of the object.

Properties

Link copied to clipboard
val filePath: String?
Link copied to clipboard
val minDaysBetweenServerAndLocalTilesVersion: Int
Link copied to clipboard
val tilesBaseUri: URI
Link copied to clipboard
val tilesDataset: String
Link copied to clipboard
val tilesProfile: String
Link copied to clipboard
val tileStore: TileStore?
Link copied to clipboard
val tilesVersion: String