MBMOfflineRegion

Deprecated


@interface MBMOfflineRegion : NSObject

An offline region represents an identifiable geographic region with optional metadata.

  • Unavailable

    Undocumented

    Declaration

    Objective-C

    - (nonnull instancetype)init NS_UNAVAILABLE;

  • Unavailable

    Undocumented

    Declaration

    Objective-C

    + (nonnull instancetype)new NS_UNAVAILABLE;

  • The regions identifier

    Declaration

    Objective-C

    - (int64_t)getIdentifier;

    Swift

    func getIdentifier() -> Int64

  • The tile pyramid defining the region. Tile pyramid and geometry definitions are mutually exclusive.

    Declaration

    Objective-C

    - (nullable MBMOfflineRegionTilePyramidDefinition *)getTilePyramidDefinition;

    Swift

    func getTilePyramidDefinition() -> MBMOfflineRegionTilePyramidDefinition?

    Return Value

    A definition describing the tile pyramid including attributes, otherwise empty.

  • The geometry defining the region. Geometry and tile pyramid definitions are mutually exclusive.

    Declaration

    Objective-C

    - (nullable MBMOfflineRegionGeometryDefinition *)getGeometryDefinition;

    Swift

    func getGeometryDefinition() -> MBMOfflineRegionGeometryDefinition?

    Return Value

    A definition describing the geometry including attributes, otherwise empty.

  • Arbitrary binary region metadata.

    Declaration

    Objective-C

    - (nonnull NSData *)getMetadata;

    Swift

    func getMetadata() -> Data

    Return Value

    The metadata associated with the region.

  • Sets the download state of an offline region A region is either inactive (not downloading, but previously-downloaded resources are available for use), or active (resources are being downloaded or will be downloaded, if necessary, when network access is available).

    If the region is already in the given state, this call is ignored.

    Declaration

    Objective-C

    - (void)setOfflineRegionDownloadStateForState:
    (MBMOfflineRegionDownloadState)state;

    Swift

    func setOfflineRegionDownloadStateFor(_ state: OfflineRegionDownloadState)

    Parameters

    state

    The new state to set.

  • Register an observer to be notified when the state of the region changes.

    Declaration

    Objective-C

    - (void)setOfflineRegionObserverForObserver:
    (nonnull id<MBMOfflineRegionObserver>)observer;

    Parameters

    observer

    The observer that will be notified when a region’s status changes.

  • Undocumented

    Declaration

    Objective-C

    - (void)setMetadataForMetadata:(nonnull NSData *)metadata
                      callback:(nonnull MBMAsyncOperationResultCallback)callback;

    Swift

    func setMetadataForMetadata(_ metadata: Data, callback: @escaping AsyncOperationResultCallback)

  • Undocumented

    Declaration

    Objective-C

    - (void)invalidateForCallback:(nonnull MBMAsyncOperationResultCallback)callback;

    Swift

    func invalidate(forCallback callback: @escaping AsyncOperationResultCallback)

  • Undocumented

    Declaration

    Objective-C

    - (void)purgeForCallback:(nonnull MBMAsyncOperationResultCallback)callback;

    Swift

    func purge(forCallback callback: @escaping AsyncOperationResultCallback)

  • Undocumented

    Declaration

    Objective-C

    - (void)getStatusForCallback:(nonnull MBMOfflineRegionStatusCallback)callback;

    Swift

    func getStatusForCallback(_ callback: @escaping OfflineRegionStatusCallback)