MBMStylePackLoadOptions.h 2.2 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455
  1. // This file is generated and will be overwritten automatically.
  2. #import <Foundation/Foundation.h>
  3. #import <MapboxCoreMaps/MBMGlyphsRasterizationMode.h>
  4. /** Describes the style package load option values. */
  5. NS_SWIFT_NAME(StylePackLoadOptions)
  6. __attribute__((visibility ("default")))
  7. @interface MBMStylePackLoadOptions : NSObject
  8. // This class provides custom init which should be called
  9. - (nonnull instancetype)init NS_UNAVAILABLE;
  10. // This class provides custom init which should be called
  11. + (nonnull instancetype)new NS_UNAVAILABLE;
  12. - (nonnull instancetype)initWithGlyphsRasterizationMode:(nullable NSNumber *)glyphsRasterizationMode
  13. metadata:(nullable id)metadata NS_REFINED_FOR_SWIFT;
  14. - (nonnull instancetype)initWithGlyphsRasterizationMode:(nullable NSNumber *)glyphsRasterizationMode
  15. metadata:(nullable id)metadata
  16. acceptExpired:(BOOL)acceptExpired NS_REFINED_FOR_SWIFT;
  17. /**
  18. * Specifies glyphs rasterization mode.
  19. *
  20. * If provided, updates the style package's glyphs rasterization mode,
  21. * which defines which glyphs will be loaded from the server.
  22. *
  23. * By default, ideographs are rasterized locally and other glyphs are loaded
  24. * from network (i.e. `IdeographsRasterizedLocally` value is used).
  25. */
  26. @property (nonatomic, readonly, nullable) NSNumber *glyphsRasterizationMode NS_REFINED_FOR_SWIFT;
  27. /**
  28. * A custom Mapbox value associated with this style package for storing metadata.
  29. *
  30. * If provided, the custom value value will be stored alongside the style package. Previous values will
  31. * be replaced with the new value.
  32. *
  33. * Developers can use this field to store custom metadata associated with a style package.
  34. */
  35. @property (nonatomic, readonly, nullable, copy) id metadata;
  36. /**
  37. * Accepts expired data when loading style resources.
  38. *
  39. * This flag should be set to true to accept expired responses. When a style resource is already loaded but expired,
  40. * no attempt will be made to refresh the data. This may lead to outdated data. Set to false to ensure that data
  41. * for a style is up-to-date.
  42. */
  43. @property (nonatomic, readonly, getter=isAcceptExpired) BOOL acceptExpired;
  44. @end