OfflineRegionInterface

interface OfflineRegionInterface

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

Functions

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

Inheritors

OfflineRegion
Link copied to clipboard