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

OfflineRegion

class OfflineRegion

Deprecated

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

Functions

Link copied to clipboard
@Nullable
@MainThread
open fun getGeometryDefinition(): OfflineRegionGeometryDefinition
The geometry defining the region.
Link copied to clipboard
@MainThread
open fun getIdentifier(): Long
The regions identifier
Link copied to clipboard
@NonNull
@MainThread
open fun getMetadata(): Array<Byte>
Arbitrary binary region metadata.
Link copied to clipboard
@MainThread
open fun getStatus(@NonNull callback: OfflineRegionStatusCallback)
Return the current status of this offline region.
Link copied to clipboard
@Nullable
@MainThread
open fun getTilePyramidDefinition(): OfflineRegionTilePyramidDefinition
The tile pyramid defining the region.
Link copied to clipboard
@MainThread
open fun invalidate(@NonNull callback: AsyncOperationResultCallback)
Invalidate all the tiles for the region forcing to revalidate the tiles with the server before using.
Link copied to clipboard
@MainThread
open fun purge(@NonNull callback: AsyncOperationResultCallback)
Remove an offline region from the database and perform any resources evictions necessary as a result.
Link copied to clipboard
@MainThread
open fun setMetadata(@NonNull metadata: Array<Byte>, @NonNull callback: AsyncOperationResultCallback)
Sets arbitrary binary region metadata for the region.
Link copied to clipboard
@MainThread
open fun setOfflineRegionDownloadState(@NonNull 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).
Link copied to clipboard
@MainThread
open fun setOfflineRegionObserver(@NonNull observer: OfflineRegionObserver)
Register an observer to be notified when the state of the region changes.