OfflineRegion class
An offline region represents an identifiable geographic region with optional metadata.
Constructors
- OfflineRegion({BinaryMessenger? binaryMessenger, String messageChannelSuffix = ''})
-
Constructor for OfflineRegion. The
binaryMessengernamed argument is available for dependency injection. If it is left null, the default BinaryMessenger will be used which routes to the host platform.
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
getGeometryDefinition(
) → Future< OfflineRegionGeometryDefinition?> - The geometry defining the region. Geometry and tile pyramid definitions are mutually exclusive.
-
getIdentifier(
) → Future< int> - The regions identifier
-
getMetadata(
) → Future< Uint8List> - Arbitrary binary region metadata.
-
getTilePyramidDefinition(
) → Future< OfflineRegionTilePyramidDefinition?> - The tile pyramid defining the region. Tile pyramid and geometry definitions are mutually exclusive.
-
invalidate(
) → Future< void> - 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.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
purge(
) → Future< void> - Remove an offline region from the database and perform any resources evictions necessary as a result.
-
setMetadata(
Uint8List metadata) → Future< void> - Sets arbitrary binary region metadata for the region.
-
setOfflineRegionDownloadState(
OfflineRegionDownloadState state) → Future< void> - 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).
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Constants
-
pigeonChannelCodec
→ const MessageCodec<
Object?>