Region (API Reference)
Class Region
Defines an area, especially part of a country or the world that can be downloaded.
-
Field Summary
FieldsModifier and TypeFieldDescriptionAll child regions for current region.Name of region.Indicates the navigability type of this region.Unique identifier specifying a region.longRepresents the total size of the region on disk in bytes, assuming no pre-existing data on the disk.longRegion size, for downloading/during network operations, in bytes. -
Constructor Summary
Constructors -
Method Summary
-
Field Details
-
regionId
Unique identifier specifying a region.
-
name
Name of region. Language is determined by the requested
LanguageCode. By default, it is inLanguageCode.EN_US. -
sizeOnDiskInBytes
public long sizeOnDiskInBytesRepresents the total size of the region on disk in bytes, assuming no pre-existing data on the disk. This value is a theoretical maximum for the region's size allocation. Note: If overlapping regions exist or data is already present on the disk, the actual size occupied might be less than this value due to shared or reused map data.
-
sizeOnNetworkInBytes
public long sizeOnNetworkInBytesRegion size, for downloading/during network operations, in bytes. Regions are downloaded in compressed form and hence they have reduced size on network. Note: This value represents the theoretical maximum size required for the region during transfer. If overlapping data already exists, the actual size downloaded may be smaller due to map data reuse.
-
childRegions
All child regions for current region. Note that each child can again contain multiple children. A downloadable region will contain the content of all children.
-
-
Constructor Details
-
Region
Creates a new instance.
- Parameters:
regionId-Unique identifier specifying a region.
-
-
Method Details