EventText
public struct EventText : Hashable
Contains all the information regarding the next text announcement.
-
Indicates the type of text announcement
Declaration
Swift
public var type: TextNotificationType -
Distance in meters to the location of the event for which the text notification is given.
Declaration
Swift
public var distanceInMeters: Double -
The text notification instruction. The text is formatted and localized as specified via
RouteTextOptions.Note: During navigation, the text will be always empty when the
Maneuveris taken from theNavigatororVisualNavigatorinstance via the provided index. The text instruction that can be accessed from theRouteinstance is meant as preview and it is not necessarily matching the more comprehensive maneuver information you can access during navigation. This information can be enhanced with real-timeManeuverNotificationstexts that can be used for spoken text notifications during a trip.Declaration
Swift
public var text: String -
Information about the next maneuver. Is non-
nilonly forEventText.typeequals toTextNotificationType.maneuver.Declaration
Swift
public var maneuverNotificationDetails: ManeuverNotificationDetails? -
Information for a spatial text notifications. When
EventTextOptions.enableSpatialAudiois false, then this attribute will benil.Declaration
Swift
public var spatialNotificationDetails: SpatialNotificationDetails? -
Creates a new instance.
Parameters
- type: Indicates the type of text announcement
- distanceInMeters: Distance in meters to the location of the event for which the text notification is given.
- text: The text notification instruction. The text is formatted and localized as specified via
RouteTextOptions.
Note: During navigation, the text will be always empty when the
Maneuveris taken from theNavigatororVisualNavigatorinstance via the provided index. The text instruction that can be accessed from theRouteinstance is meant as preview and it is not necessarily matching the more comprehensive maneuver information you can access during navigation. This information can be enhanced with real-timeManeuverNotificationstexts that can be used for spoken text notifications during a trip.- maneuverNotificationDetails: Information about the next maneuver.
Is non-
nilonly forEventText.typeequals toTextNotificationType.maneuver. - spatialNotificationDetails: Information for a spatial text notifications.
When
EventTextOptions.enableSpatialAudiois false, then this attribute will benil.
Declaration
Swift
public init(type: TextNotificationType, distanceInMeters: Double, text: String, maneuverNotificationDetails: ManeuverNotificationDetails? = nil, spatialNotificationDetails: SpatialNotificationDetails? = nil)