MBMOfflineRegionStatus

Deprecated


@interface MBMOfflineRegionStatus : NSObject

A region’s status includes its active/inactive state as well as counts of the number of resources that have completed downloading, their total size in bytes, and the total number of resources that are required.

Note that the total required size in bytes is not currently available. A future API release may provide an estimate of this number.

  • Unavailable

    Undocumented

    Declaration

    Objective-C

    - (nonnull instancetype)init NS_UNAVAILABLE;

  • Unavailable

    Undocumented

    Declaration

    Objective-C

    + (nonnull instancetype)new NS_UNAVAILABLE;

  • Undocumented

    Declaration

    Objective-C

    - (nonnull instancetype)initWithDownloadState:(MBMOfflineRegionDownloadState)downloadState
                       completedResourceCount:(uint64_t)completedResourceCount
                        completedResourceSize:(uint64_t)completedResourceSize
                           completedTileCount:(uint64_t)completedTileCount
                            requiredTileCount:(uint64_t)requiredTileCount
                            completedTileSize:(uint64_t)completedTileSize
                        requiredResourceCount:(uint64_t)requiredResourceCount
               requiredResourceCountIsPrecise:(BOOL)requiredResourceCountIsPrecise;

    Swift

    init(downloadState: OfflineRegionDownloadState, completedResourceCount: UInt64, completedResourceSize: UInt64, completedTileCount: UInt64, requiredTileCount: UInt64, completedTileSize: UInt64, requiredResourceCount: UInt64, requiredResourceCountIsPrecise: Bool)

  • Describes the download state.

    Declaration

    Objective-C

    @property (nonatomic, readonly) MBMOfflineRegionDownloadState downloadState;

    Swift

    var downloadState: OfflineRegionDownloadState { get }

  • The number of resources that have been fully downloaded and are ready for offline access.

    Declaration

    Objective-C

    @property (nonatomic, readonly) uint64_t completedResourceCount;

    Swift

    var completedResourceCount: UInt64 { get }

  • The cumulative size, in bytes, of all resources (inclusive of tiles) that have been fully downloaded.

    Declaration

    Objective-C

    @property (nonatomic, readonly) uint64_t completedResourceSize;

    Swift

    var completedResourceSize: UInt64 { get }

  • The number of tiles that are known to be required for this region. This is a subset of completedResourceCount.

    Declaration

    Objective-C

    @property (nonatomic, readonly) uint64_t completedTileCount;

    Swift

    var completedTileCount: UInt64 { get }

  • The number of tiles that are known to be required for this region.

    Declaration

    Objective-C

    @property (nonatomic, readonly) uint64_t requiredTileCount;

    Swift

    var requiredTileCount: UInt64 { get }

  • The cumulative size, in bytes, of all tiles that have been fully downloaded. This is a subset of completedResourceSize.

    Declaration

    Objective-C

    @property (nonatomic, readonly) uint64_t completedTileSize;

    Swift

    var completedTileSize: UInt64 { get }

  • The number of resources that are known to be required for this region. See the documentation for requiredResourceCountIsPrecise for an important caveat about this number.

    Declaration

    Objective-C

    @property (nonatomic, readonly) uint64_t requiredResourceCount;

    Swift

    var requiredResourceCount: UInt64 { get }

  • This property is true when the value of requiredResourceCount is a precise count of the number of required resources, and false when it is merely a lower bound.

    Specifically, it is false during early phases of an offline download. Once style and tile sources have been downloaded, it is possible to calculate the precise number of required resources, at which point it is set to true.

    Declaration

    Objective-C

    @property (nonatomic, readonly, getter=isRequiredResourceCountIsPrecise) BOOL requiredResourceCountIsPrecise;

    Swift

    var isRequiredResourceCountIsPrecise: Bool { get }