MBXTileStoreOptions.h 2.5 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647
  1. // This file is generated and will be overwritten automatically.
  2. #import <Foundation/Foundation.h>
  3. /** These constants can be used as keys for TileStore::setOption to configure further aspects of a TileStore instance. */
  4. NS_SWIFT_NAME(TileStoreOptions)
  5. __attribute__((visibility ("default")))
  6. @interface MBXTileStoreOptions : NSObject
  7. /**
  8. * If the new value causes the quota to be exceed, data will be evicted to enforce the quota.
  9. * Accepts a (positive) number of bytes, or null for resetting to the default value.
  10. */
  11. @property (nonatomic, class, readonly) NSString * DiskQuota;
  12. /**
  13. * Sets the access token to use for tile requests. Defaults to use the access token from the application's
  14. * manifest or the environment if unset.
  15. * Accepts a string, or null for resetting to the default value.
  16. */
  17. @property (nonatomic, class, readonly) NSString * MapboxAccessToken;
  18. /**
  19. * Sets the base URL to use for requests to the Mapbox API. Defaults to "https://api.mapbox.com".
  20. * Accepts a string, or null for resetting to the default value.
  21. */
  22. @property (nonatomic, class, readonly) NSString * MapboxAPIURL;
  23. /**
  24. * Sets the URL template for making tile requests. Defaults to the Mapbox API endpoints.
  25. * Accepts a string, or null for resetting to the default value.
  26. *
  27. * The template string for the URL, which may contain the following placeholders:
  28. * - {mapbox_api_url}: The globally set Mapbox API URL, or the default endpoint if none is set.
  29. * - {mapbox_access_token}: The access token, or an empty string if none is set.
  30. * - {mapbox_sku_token}: The Mapbox SKU token for the tile.
  31. * - {domain}: A lowercase string representing the data domain, e.g. 'maps', or 'navigation'.
  32. * - {dataset}: The dataset of the tile to be loaded, e.g. 'mapbox.mapbox-streets-v8'.
  33. * - {version}: The dataset version of the tile to be loaded, if applicable.
  34. * - {level}: The level of the Navigation tile to be loaded.
  35. * - {graph_id}: The graph ID suffix of the Navigation tile to be loaded. E.g. '002/958/221'
  36. * - {z}: The zoom level of the Map tile to be loaded.
  37. * - {x}: The x coordinate of the Map tile to be loaded.
  38. * - {y}: The y coordinate of the Map tile to be loaded.
  39. * - {z_min}: The zoom range minimum of the Map tile to be loaded.
  40. * - {z_max}: The zoom range maximum of the Map tile to be loaded.
  41. */
  42. @property (nonatomic, class, readonly) NSString * TileURLTemplate;
  43. @end