Region

public struct Region : Hashable

Defines an area, especially part of a country or the world that can be downloaded.

  • Unique identifier specifying a region.

    Declaration

    Swift

    public var regionId: RegionId

  • Name of region. Language is determined by the requested LanguageCode. By default, it is in LanguageCode.enUs.

    Declaration

    Swift

    public var name: String

  • Represents 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.

    Declaration

    Swift

    public var sizeOnDiskInBytes: Int64

  • Region 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.

    Declaration

    Swift

    public var sizeOnNetworkInBytes: Int64

  • 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.

    Declaration

    Swift

    public var childRegions: [Region]?

  • Indicates the navigability type of this region.

    Declaration

    Swift

    public var navigability: NavigabilityType

  • Creates a new instance.

    Declaration

    Swift

    public init(regionId: RegionId, name: String = "", sizeOnDiskInBytes: Int64 = 0, sizeOnNetworkInBytes: Int64 = 0, childRegions: [Region]? = nil, navigability: NavigabilityType = NavigabilityType.navigable)