NavigationEventsManager

 
open class NavigationEventsManager

The NavigationEventsManager is responsible for being the liaison between MapboxNavigation and the Mapbox telemetry framework.

  • When set to false, flushing of telemetry events is not delayed. Is set to true by default.

    Declaration

    Swift

    public var delaysEventFlushing: Bool
    View Source on GitHub

  • Send feedback about the current road segment/maneuver to the Mapbox data team.

    You can pair this with a custom feedback UI in your app to flag problems during navigation such as road closures, incorrect instructions, etc.

    @param type A FeedbackType used to specify the type of feedback @param description A custom string used to describe the problem in detail. @return Returns a UUID used to identify the feedback event

    If you provide a custom feedback UI that lets users elaborate on an issue, you should call this before you show the custom UI so the location and timestamp are more accurate.

    You can then call updateFeedback(uuid:type:source:description:) with the returned feedback UUID to attach any additional metadata to the feedback.

    Declaration

    Swift

    public func recordFeedback(type: FeedbackType = .general, description: String? = nil) -> UUID?
    View Source on GitHub

  • Update the feedback event with a specific feedback identifier. If you implement a custom feedback UI that lets a user elaborate on an issue, you can use this to update the metadata.

    Note that feedback is sent 20 seconds after being recorded, so you should promptly update the feedback metadata after the user discards any feedback UI.

    Declaration

    Swift

    public func updateFeedback(uuid: UUID, type: FeedbackType, source: FeedbackSource, description: String?)
    View Source on GitHub

  • Discard a recorded feedback event, for example if you have a custom feedback UI and the user canceled feedback.

    Declaration

    Swift

    public func cancelFeedback(uuid: UUID)
    View Source on GitHub