Road

public struct Road
extension Road: 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(
    name: String,
    numbers: [String],
    shields: [RoadShield],
    types: Set<TomTomSDKRoute.RoadType> = []
) throws

    Parameters

    name

    The name of the road.
    numbers

    The road numbers.
    shields

    The road shields.
    types

    Indicates a road types.

Public

  • Text content of the road name.

    Declaration

    Swift

    public let name: String

  • The road numbers.

    Declaration

    Swift

    public let numbers: [String]

  • The road shields.

    Declaration

    Swift

    public let shields: [RoadShield]

  • Indicates a road types.

    Declaration

    Swift

    public let types: Set<TomTomSDKRoute.RoadType>

Road.InitializationError

  • 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