MBMResourceOptions

 

@interface MBMResourceOptions : NSObject

Options to configure a resource

  • Unavailable

    Undocumented

    Declaration

    Objective-C

    - (nonnull instancetype)init NS_UNAVAILABLE;

  • Unavailable

    Undocumented

    Declaration

    Objective-C

    + (nonnull instancetype)new NS_UNAVAILABLE;

  • Undocumented

    Declaration

    Objective-C

    - (nonnull instancetype)initWithAccessToken:(nonnull NSString *)accessToken
                                    baseURL:(nullable NSString *)baseURL
                                   dataPath:(nullable NSString *)dataPath
                                  assetPath:(nullable NSString *)assetPath
                                  tileStore:(nullable MBXTileStore *)tileStore;

    Swift

    init(accessToken: String, baseURL: String?, dataPath: String?, assetPath: String?, tileStore: MBXTileStore?)

  • Undocumented

    Declaration

    Objective-C

    - (nonnull instancetype)initWithAccessToken:(nonnull NSString *)accessToken
                                    baseURL:(nullable NSString *)baseURL
                                   dataPath:(nullable NSString *)dataPath
                                  assetPath:(nullable NSString *)assetPath
                                  tileStore:(nullable MBXTileStore *)tileStore
                         tileStoreUsageMode:(MBMTileStoreUsageMode)tileStoreUsageMode;

    Swift

    init(accessToken: String, baseURL: String?, dataPath: String?, assetPath: String?, tileStore: MBXTileStore?, tileStoreUsageMode: TileStoreUsageMode)

  • The access token that is used to access resources provided by Mapbox services.

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly, nonnull) NSString *accessToken;

    Swift

    var accessToken: String { get }

  • The base URL that would be used to make HTTP requests. By default it is https://api.mapbox.com.

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly, nullable) NSString *baseURL;

    Swift

    var baseURL: String? { get }

  • The path to the map data folder.

    The implementation will use this folder for storing offline style packages and temporary data.

    The application must have sufficient permissions to create files within the provided directory. If a dataPath is not provided, the default location will be used (the application data path defined in the Mapbox Common SystemInformation API).

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly, nullable) NSString *dataPath;

    Swift

    var dataPath: String? { get }

  • The path to the folder where application assets are located. Resources whose protocol is asset:// will be fetched from an asset folder or asset management system provided by respective platform. This option is ignored for Android platform. An iOS application may provide path to an application bundle’s path.

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly, nullable) NSString *assetPath;

    Swift

    var assetPath: String? { get }

  • The tile store instance.

    This setting can be applied only if tile store usage is enabled, otherwise it is ignored.

    If not set and tile store usage is enabled, a tile store at the default location will be created and used.

    Declaration

    Objective-C

    @property (nonatomic, readonly, nullable) MBXTileStore *tileStore;

    Swift

    var tileStore: MBXTileStore? { get }

  • The tile store usage mode.

    Declaration

    Objective-C

    @property (nonatomic, readonly) MBMTileStoreUsageMode tileStoreUsageMode;

    Swift

    var tileStoreUsageMode: TileStoreUsageMode { get }