MBXTileRegion.h 1.7 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950
  1. // This file is generated and will be overwritten automatically.
  2. #import <Foundation/Foundation.h>
  3. /** TileRegion represents an identifiable geographic tile region with metadata */
  4. NS_SWIFT_NAME(TileRegion)
  5. __attribute__((visibility ("default")))
  6. @interface MBXTileRegion : NSObject
  7. // This class provides custom init which should be called
  8. - (nonnull instancetype)init NS_UNAVAILABLE;
  9. // This class provides custom init which should be called
  10. + (nonnull instancetype)new NS_UNAVAILABLE;
  11. - (nonnull instancetype)initWithId:(nonnull NSString *)id
  12. requiredResourceCount:(uint64_t)requiredResourceCount
  13. completedResourceCount:(uint64_t)completedResourceCount
  14. completedResourceSize:(uint64_t)completedResourceSize
  15. expires:(nullable NSDate *)expires;
  16. /** The id of the tile region */
  17. @property (nonatomic, readonly, nonnull, copy) NSString *id;
  18. /** The number of resources that are known to be required for this tile region. */
  19. @property (nonatomic, readonly) uint64_t requiredResourceCount;
  20. /**
  21. * The number of resources that have been fully downloaded and are ready for
  22. * offline access.
  23. *
  24. * The tile region is complete if `completedResourceCount` is equal to `requiredResourceCount`.
  25. */
  26. @property (nonatomic, readonly) uint64_t completedResourceCount;
  27. /**
  28. * The cumulative size, in bytes, of all resources (inclusive of tiles) that have
  29. * been fully downloaded.
  30. */
  31. @property (nonatomic, readonly) uint64_t completedResourceSize;
  32. /**
  33. * The earliest point in time when any of the region resources gets expired.
  34. *
  35. * Unitialized for incomplete tile regions or for complete tile regions with all immutable resources.
  36. */
  37. @property (nonatomic, readonly, nullable) NSDate *expires;
  38. @end