mapbox-maps-android/com.mapbox.common/TileStore(androidJvm)/loadTileRegion

loadTileRegion

Loads a new tile region or updates the existing one. Creating of a new region requires providing both geometry and tileset descriptors to the given load options, otherwise the load request fails with RegionNotFound error. If a tile region with the given id already exists, it gets updated with the values provided to the given load options. The missing resources get loaded and the expired resources get updated. If there no values provided to the given load options, the existing tile region gets refreshed: the missing resources get loaded and the expired resources get updated. A failed load request can be reattempted with another loadTileRegion() call. If there is already a pending loading operation for the tile region with the given id the pending loading operation will fail with an error of Canceled type. Note: The user-provided callbacks will be executed on a TileStore-controlled worker thread; it is the responsibility of the user to dispatch to a user-controlled thread.

Return

Returns a Cancelable object to cancel the load request

Parameters

The tile region identifier.

loadOptions

The tile region load options.

onFinished

Invoked only once upon success, failure, or cancelation of the loading operation.

onProgress

Invoked multiple times to report progess of the loading operation.

@NonNull()

open fun loadTileRegion(id: String, loadOptions: TileRegionLoadOptions, onProgress: TileRegionLoadProgressCallback, onFinished: TileRegionCallback): Cancelable

An overloaded version that does not report progess of the loading operation.

Return

Returns a Cancelable object to cancel the load request

Parameters

The tile region identifier.

loadOptions

The tile region load options.

onFinished

Invoked only once upon success, failure, or cancelation of the loading operation.

@NonNull()

open fun loadTileRegion(id: String, loadOptions: TileRegionLoadOptions, onFinished: TileRegionCallback): Cancelable

An overloaded version that does not report progess or finished status of the loading operation.

Return

Returns a Cancelable object to cancel the load request

Parameters

The tile region identifier.

loadOptions

The tile region load options.

@NonNull()

open fun loadTileRegion(id: String, loadOptions: TileRegionLoadOptions): Cancelable