EventText Structure Reference


                    
                    
                    type

Indicates the type of text announcement

Declaration

Swift

public var type: TextNotificationType


                    
                    
                    distanceInMeters

Distance in meters to the location of the event for which the text notification is given.

Declaration

Swift

public var distanceInMeters: Double


                    
                    
                    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 Maneuver is taken from the Navigator or VisualNavigator instance via the provided index. The text instruction that can be accessed from the Route instance 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-time ManeuverNotifications texts that can be used for spoken text notifications during a trip.

Declaration

Swift

public var text: String


                    
                    
                    maneuverNotificationDetails

Information about the next maneuver. Is non-nil only for EventText.type equals to TextNotificationType.maneuver.

Declaration

Swift

public var maneuverNotificationDetails: ManeuverNotificationDetails?


                    
                    
                    spatialNotificationDetails

Information for a spatial text notifications. When EventTextOptions.enableSpatialAudio is false, then this attribute will be nil.

Declaration

Swift

public var spatialNotificationDetails: SpatialNotificationDetails?


                    
                    
                    init(type:distanceInMeters:text:maneuverNotificationDetails: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 Maneuver is taken from the Navigator or VisualNavigator instance via the provided index. The text instruction that can be accessed from the Route instance 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-time ManeuverNotifications texts that can be used for spoken text notifications during a trip.
- maneuverNotificationDetails: Information about the next maneuver. Is non-nil only for EventText.type equals to TextNotificationType.maneuver.
- spatialNotificationDetails: Information for a spatial text notifications. When EventTextOptions.enableSpatialAudio is false, then this attribute will be nil.

Declaration

Swift

public init(type: TextNotificationType, distanceInMeters: Double, text: String, maneuverNotificationDetails: ManeuverNotificationDetails? = nil, spatialNotificationDetails: SpatialNotificationDetails? = nil)