mapbox-maps-android/com.mapbox.maps/OfflineRegion

OfflineRegion

class OfflineRegion : OfflineRegionInterface

An offline region represents an identifiable geographic region with optional metadata.

Functions

getGeometryDefinition

androidJvm

open fun getGeometryDefinition(): OfflineRegionGeometryDefinition

The geometry defining the region.

getIdentifier

androidJvm

open fun getIdentifier(): Long

The regions identifier

getMetadata

androidJvm

open fun getMetadata(): Array<Byte>

Arbitrary binary region metadata.

getStatus

androidJvm

open fun getStatus(callback: OfflineRegionStatusCallback)

Return the current status of this offline region.

getTilePyramidDefinition

androidJvm

open fun getTilePyramidDefinition(): OfflineRegionTilePyramidDefinition

The tile pyramid defining the region.

invalidate

androidJvm

open fun invalidate(callback: AsyncOperationResultCallback)

Invalidate all the tiles for the region forcing to revalidate the tiles with the server before using.

purge

androidJvm

open fun purge(callback: AsyncOperationResultCallback)

Remove an offline region from the database and perform any resources evictions necessary as a result.

setMetadata

androidJvm

open fun setMetadata(metadata: Array<Byte>, callback: AsyncOperationResultCallback)

Sets arbitrary binary region metadata for the region.

setOfflineRegionDownloadState

androidJvm

open fun setOfflineRegionDownloadState(state: OfflineRegionDownloadState)

Sets the download state of an offline region A region is either inactive (not downloading, but previously-downloaded resources are available for use), or active (resources are being downloaded or will be downloaded, if necessary, when network access is available).

setOfflineRegionObserver

androidJvm

open fun setOfflineRegionObserver(observer: OfflineRegionObserver)

Register an observer to be notified when the state of the region changes.