Install in Dash
NavigationEventsManager Class Reference
NavigationEventsManager
open class NavigationEventsManagerThe NavigationEventsManager is responsible for being the liaison between MapboxCoreNavigation and the Mapbox telemetry.
-
Optional application metadata that that can help Mapbox more reliably diagnose problems that occur in the SDK. For example, you can provide your application’s name and version, a unique identifier for the end user, and a session identifier. To include this information, use the following keys: “name”, “version”, “userId”, and “sessionId”.
Declaration
Swift
public var userInfo: [String : String?]? { get set } -
When set to
false, flushing of telemetry events is not delayed. Is set totrueby default.Declaration
Swift
public var delaysEventFlushing: Bool { get set } -
The unique identifier of the navigation session. Soon to be unused.
Declaration
Swift
public var sessionId: String { get }
View Source on GitHub
-
Create feedback about the current road segment/maneuver to be sent 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.
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. Alternatively, you can use
FeedbackViewContollerwhich handles feedback lifecycle internally.Postcondition
CallsendFeedback(_:type:source:description:)with the returned feedback to attach additional metadata to the feedback and send it.Declaration
Swift
public func createFeedback(screenshotOption: FeedbackScreenshotOption = .automatic) -> FeedbackEvent?Return Value
Returns a feedback event.
-
Send active navigation feedback 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.
Declaration
Swift
public func sendActiveNavigationFeedback(_ feedback: FeedbackEvent, type: ActiveNavigationFeedbackType, description: String? = nil)Parameters
feedbackA
FeedbackEventcreated withcreateFeedback()method.typeA
ActiveNavigationFeedbackTypeused to specify the type of feedback.descriptionA custom string used to describe the problem in detail.
-
Send passive navigation feedback 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.
Declaration
Swift
public func sendPassiveNavigationFeedback(_ feedback: FeedbackEvent, type: PassiveNavigationFeedbackType, description: String? = nil)Parameters
feedbackA
FeedbackEventcreated withcreateFeedback()method.typeA
PassiveNavigationFeedbackTypeused to specify the type of feedback.descriptionA custom string used to describe the problem in detail.
-
Send event that Car Play was connected.
Declaration
Swift
public func sendCarPlayConnectEvent() -
Send event that Car Play was disconnected.
Declaration
Swift
public func sendCarPlayDisconnectEvent()