OverlayServiceContext

Objective-C


@interface OverlayServiceContext : NSObject

Swift

class OverlayServiceContext : NSObject

This class encapsulates overlay service information.

  • Get list of SDK available overlays.

    Declaration

    Objective-C

    - (nullable OverlayCollectionObject *)getAvailableOverlays;

    Swift

    func getAvailableOverlays() -> OverlayCollectionObject?

  • Enables the overlay with the given uid. This will activate the overlay for all registered services ( map views, alarms, etc ).

    Declaration

    Objective-C

    - (SDKErrorCode)enableOverlay:(int)uid;

    Swift

    func enableOverlay(_ uid: Int32) -> SDKErrorCode

    Parameters

    uid

    The overlay uid.

  • Enables the overlay with the given uid. This will activate the overlay for all registered services ( map views, alarms, etc ).

    Declaration

    Objective-C

    - (SDKErrorCode)enableOverlay:(int)uid category:(int)categUid;

    Swift

    func enableOverlay(_ uid: Int32, category categUid: Int32) -> SDKErrorCode

    Parameters

    uid

    The overlay uid.
    categUid

    The overlay category uid.

  • Disables the overlay with the given uid. This will deactivate the overlay for all registered services ( map views, alarms, etc )

    Declaration

    Objective-C

    - (SDKErrorCode)disableOverlay:(int)uid;

    Swift

    func disableOverlay(_ uid: Int32) -> SDKErrorCode

    Parameters

    uid

    The overlay uid.

  • Disables the overlay with the given uid. This will deactivate the overlay for all registered services ( map views, alarms, etc )

    Declaration

    Objective-C

    - (SDKErrorCode)disableOverlay:(int)uid category:(int)categUid;

    Swift

    func disableOverlay(_ uid: Int32, category categUid: Int32) -> SDKErrorCode

    Parameters

    uid

    The overlay uid.
    categUid

    The overlay category uid.

  • Check if the overlay with the given uid is enabled.

    Declaration

    Objective-C

    - (BOOL)isOverlayEnabled:(int)uid;

    Swift

    func isOverlayEnabled(_ uid: Int32) -> Bool

    Parameters

    uid

    The overlay uid.

  • Check if the overlay with the given uid is enabled.

    Declaration

    Objective-C

    - (BOOL)isOverlayEnabled:(int)uid category:(int)categUid;

    Swift

    func isOverlayEnabled(_ uid: Int32, category categUid: Int32) -> Bool

    Parameters

    uid

    The overlay uid.
    categUid

    The overlay category uid.

  • Enables the offline data grabber for the overlay with the given uid.

    Declaration

    Objective-C

    - (SDKErrorCode)enableOverlayOfflineDataGrabber:(int)uid;

    Swift

    func enableOverlayOfflineDataGrabber(_ uid: Int32) -> SDKErrorCode

    Parameters

    uid

    The overlay uid. @details The offline data grabber downloads an overlay covering dataset for every new downloaded road map content. @details The offline data is automatically grabbed immediately after a road map content download finishes & is stored in the SDK permanent cache.

  • Disables the offline data grabber for the overlay with the given uid.

    Declaration

    Objective-C

    - (SDKErrorCode)disableOverlayOfflineDataGrabber:(int)uid;

    Swift

    func disableOverlayOfflineDataGrabber(_ uid: Int32) -> SDKErrorCode

    Parameters

    uid

    The overlay uid.

  • Check if the offline data grabber for the given overlay uid is enabled.

    Declaration

    Objective-C

    - (BOOL)isOverlayOfflineDataGrabberEnabled:(int)uid;

    Swift

    func isOverlayOfflineDataGrabberEnabled(_ uid: Int32) -> Bool

    Parameters

    uid

    The overlay uid.

  • Check if the offline data grabber for the given overlay uid is supported.

    Declaration

    Objective-C

    - (BOOL)isOverlayOfflineDataGrabberSupported:(int)uid;

    Swift

    func isOverlayOfflineDataGrabberSupported(_ uid: Int32) -> Bool

    Parameters

    uid

    The overlay uid.

  • Grab latest overlay offline data over all existing offline maps area.

    Declaration

    Objective-C

    - (void)grabOverlayOfflineData:(int)uid
             completionHandler:(nonnull void (^)(BOOL))handler;

    Swift

    func grabOverlayOfflineData(_ uid: Int32) async -> Bool

    Parameters

    uid

    The overlay uid.

  • Cancel request to grab latest overlay offline data.

    Declaration

    Objective-C

    - (void)cancelGrabOverlayOfflineData:(int)uid;

    Swift

    func cancelGrabOverlayOfflineData(_ uid: Int32)

    Parameters

    uid

    The overlay uid.