MBMOfflineRegionStatus.h 3.2 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283
  1. // This file is generated and will be overwritten automatically.
  2. #import <Foundation/Foundation.h>
  3. #import <MapboxCoreMaps/MBMOfflineRegionDownloadState.h>
  4. /**
  5. * A region's status includes its active/inactive state as well as counts
  6. * of the number of resources that have completed downloading, their total
  7. * size in bytes, and the total number of resources that are required.
  8. *
  9. * Note that the total required size in bytes is not currently available. A
  10. * future API release may provide an estimate of this number.
  11. */
  12. NS_SWIFT_NAME(OfflineRegionStatus)
  13. __attribute__((visibility ("default")))
  14. __attribute__((deprecated))
  15. @interface MBMOfflineRegionStatus : NSObject
  16. // This class provides custom init which should be called
  17. - (nonnull instancetype)init NS_UNAVAILABLE;
  18. // This class provides custom init which should be called
  19. + (nonnull instancetype)new NS_UNAVAILABLE;
  20. - (nonnull instancetype)initWithDownloadState:(MBMOfflineRegionDownloadState)downloadState
  21. completedResourceCount:(uint64_t)completedResourceCount
  22. completedResourceSize:(uint64_t)completedResourceSize
  23. completedTileCount:(uint64_t)completedTileCount
  24. requiredTileCount:(uint64_t)requiredTileCount
  25. completedTileSize:(uint64_t)completedTileSize
  26. requiredResourceCount:(uint64_t)requiredResourceCount
  27. requiredResourceCountIsPrecise:(BOOL)requiredResourceCountIsPrecise;
  28. /** Describes the download state. */
  29. @property (nonatomic, readonly) MBMOfflineRegionDownloadState downloadState;
  30. /**
  31. * The number of resources that have been fully downloaded and are ready for
  32. * offline access.
  33. */
  34. @property (nonatomic, readonly) uint64_t completedResourceCount;
  35. /**
  36. * The cumulative size, in bytes, of all resources (inclusive of tiles) that have
  37. * been fully downloaded.
  38. */
  39. @property (nonatomic, readonly) uint64_t completedResourceSize;
  40. /**
  41. * The number of tiles that are known to be required for this region. This is a
  42. * subset of `completedResourceCount`.
  43. */
  44. @property (nonatomic, readonly) uint64_t completedTileCount;
  45. /** The number of tiles that are known to be required for this region. */
  46. @property (nonatomic, readonly) uint64_t requiredTileCount;
  47. /**
  48. * The cumulative size, in bytes, of all tiles that have been fully downloaded.
  49. * This is a subset of `completedResourceSize`.
  50. */
  51. @property (nonatomic, readonly) uint64_t completedTileSize;
  52. /**
  53. * The number of resources that are known to be required for this region. See the
  54. * documentation for `requiredResourceCountIsPrecise` for an important caveat
  55. * about this number.
  56. */
  57. @property (nonatomic, readonly) uint64_t requiredResourceCount;
  58. /**
  59. * This property is true when the value of requiredResourceCount is a precise
  60. * count of the number of required resources, and false when it is merely a lower
  61. * bound.
  62. *
  63. * Specifically, it is false during early phases of an offline download. Once
  64. * style and tile sources have been downloaded, it is possible to calculate the
  65. * precise number of required resources, at which point it is set to true.
  66. */
  67. @property (nonatomic, readonly, getter=isRequiredResourceCountIsPrecise) BOOL requiredResourceCountIsPrecise;
  68. @end