RoadInformation

public struct RoadInformation
extension RoadInformation: Equatable

Road information relating to a GuidanceInstruction.

Important

This is a Public Preview API. It may be changed or removed at any time.

Lifecycle

  • Creates the instance with the specified properties.

    Throws

    If all properties are empty, the error InitializationError.incorrectInputs thrown.

    Declaration

    Swift

    public init(
        roadName: String,
        roadNumbers: [String],
        roadNumberShields: [RoadShield],
        roadTypes: Set<TomTomSDKRoute.RoadType> = []
    ) throws

    Parameters

    roadName

    The name of the road.

    roadNumbers

    The road numbers.

    roadShields

    The road numbers, contain detailed information about road shields.

    roadTypes

    Indicates a road types.

Public

  • Text content of the road name.

    Declaration

    Swift

    public let roadName: String
  • The road numbers.

    Declaration

    Swift

    public let roadNumbers: [String]
  • The road numbers, contain detailed information about road shields.

    Declaration

    Swift

    public let roadNumberShields: [RoadShield]
  • Indicates a road types.

    Declaration

    Swift

    public let roadTypes: Set<TomTomSDKRoute.RoadType>

Equatable

  • An error that occurs during the creation of the instance.

    Important

    This is a Public Preview API. It may be changed or removed at any time.
    See more

    Declaration

    Swift

    public enum InitializationError : Error