OfflineRegionInterface(androidJvm)

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

interface OfflineRegionInterface(androidJvm)

Functions

getGeometryDefinition
Link copied to clipboard

The geometry defining the region. Geometry and tile pyramid definitions are mutually exclusive.

abstract fun getGeometryDefinition(): OfflineRegionGeometryDefinition
getIdentifier
Link copied to clipboard

The regions identifier

abstract fun getIdentifier(): Long
getMetadata
Link copied to clipboard

Arbitrary binary region metadata.

abstract fun getMetadata(): Array<Byte>
getTilePyramidDefinition
Link copied to clipboard

The tile pyramid defining the region. Tile pyramid and geometry definitions are mutually exclusive.

abstract fun getTilePyramidDefinition(): OfflineRegionTilePyramidDefinition
invalidate
Link copied to clipboard

Invalidate all the tiles for the region forcing to revalidate the tiles with the server before using. This is more efficient than deleting the offline region and downloading it again because if the data on the cache matches the server, no new data gets transmitted.

abstract fun invalidate(callback: AsyncOperationResultCallback)
purge
Link copied to clipboard

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

abstract fun purge(callback: AsyncOperationResultCallback)
setOfflineRegionDownloadState
Link copied to clipboard

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). If the region is already in the given state, this call is ignored.

abstract fun setOfflineRegionDownloadState(state: OfflineRegionDownloadState)
setOfflineRegionObserver
Link copied to clipboard

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

abstract fun setOfflineRegionObserver(observer: OfflineRegionObserver)

Inheritors

OfflineRegion
Link copied to clipboard