MBMResourceOptions.h 2.9 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071
  1. // This file is generated and will be overwritten automatically.
  2. #import <Foundation/Foundation.h>
  3. #import <MapboxCoreMaps/MBMTileStoreUsageMode.h>
  4. @class MBXTileStore;
  5. /** Options to configure a resource */
  6. NS_SWIFT_NAME(ResourceOptions)
  7. __attribute__((visibility ("default")))
  8. @interface MBMResourceOptions : NSObject
  9. // This class provides custom init which should be called
  10. - (nonnull instancetype)init NS_UNAVAILABLE;
  11. // This class provides custom init which should be called
  12. + (nonnull instancetype)new NS_UNAVAILABLE;
  13. - (nonnull instancetype)initWithAccessToken:(nonnull NSString *)accessToken
  14. baseURL:(nullable NSString *)baseURL
  15. dataPath:(nullable NSString *)dataPath
  16. assetPath:(nullable NSString *)assetPath
  17. tileStore:(nullable MBXTileStore *)tileStore;
  18. - (nonnull instancetype)initWithAccessToken:(nonnull NSString *)accessToken
  19. baseURL:(nullable NSString *)baseURL
  20. dataPath:(nullable NSString *)dataPath
  21. assetPath:(nullable NSString *)assetPath
  22. tileStore:(nullable MBXTileStore *)tileStore
  23. tileStoreUsageMode:(MBMTileStoreUsageMode)tileStoreUsageMode;
  24. /** The access token that is used to access resources provided by Mapbox services. */
  25. @property (nonatomic, readonly, nonnull, copy) NSString *accessToken;
  26. /** The base URL that would be used to make HTTP requests. By default it is `https://api.mapbox.com`. */
  27. @property (nonatomic, readonly, nullable, copy) NSString *baseURL;
  28. /**
  29. * The path to the map data folder.
  30. *
  31. * The implementation will use this folder for storing offline style packages and temporary data.
  32. *
  33. * The application must have sufficient permissions to create files within the provided directory.
  34. * If a dataPath is not provided, the default location will be used (the application data path defined
  35. * in the `Mapbox Common SystemInformation API`).
  36. */
  37. @property (nonatomic, readonly, nullable, copy) NSString *dataPath;
  38. /**
  39. * The path to the folder where application assets are located. Resources whose protocol is `asset://`
  40. * will be fetched from an asset folder or asset management system provided by respective platform.
  41. * This option is ignored for Android platform. An iOS application may provide path to an application bundle's path.
  42. */
  43. @property (nonatomic, readonly, nullable, copy) NSString *assetPath;
  44. /**
  45. * The tile store instance.
  46. *
  47. * This setting can be applied only if tile store usage is enabled,
  48. * otherwise it is ignored.
  49. *
  50. * If not set and tile store usage is enabled, a tile store at the default
  51. * location will be created and used.
  52. */
  53. @property (nonatomic, readonly, nullable) MBXTileStore *tileStore;
  54. /** The tile store usage mode. */
  55. @property (nonatomic, readonly) MBMTileStoreUsageMode tileStoreUsageMode;
  56. @end