GuidanceOptions

public struct GuidanceOptions

Specifies options related to generated instructions. It is used by RoutePlanningOptions when planning a route.

Lifecycle


                    
                    
                    init(guidanceVersion:instructionType:language:roadShieldReferences:announcementPoints:phoneticsType:extendedSections:progressPoints:)

Creates a new GuidanceOptions instance with provided parameters.

Throws

An error of the type GuidanceOptionError.unsupportedCombinationOfOptions

Declaration

Swift

@available(*, deprecated, message: "This API is deprecated and will be removed with the next major release. Please use the new initializer instead.")
public init
    (
        guidanceVersion: OnlineApiVersion = .v1,
        instructionType: InstructionType = .text,
        language: Locale = Locale(identifier: "en-US"),
        roadShieldReferences: RoadShieldReferences = .none,
        announcementPoints: AnnouncementPoints = .none,
        phoneticsType: InstructionPhoneticsType = .none,
        extendedSections: ExtendedSections = .none,
        progressPoints: ProgressPoints = .none
    ) throws

Parameters

`guidanceVersion`	The version of the guidance API to be used. By default it is equal to the `OnlineApiVersion.v1` value.
`instructionType`	The format in which instructions are reported. By default it is equal to the `InstructionType.text` value.
`language`	The language of the guidance messages. By default it is equal to “en-US”.
`roadShieldReferences`	Whether to include references to road shields in instructions. By default it is equal to the `RoadShieldReferences.none` value.
`announcementPoints`	Whether to include announcement points in instructions. By default it is equal to the `AnnouncementPoints.none` value.
`phoneticsType`	The format of phonetic instruction transcriptions. By default it is equal to the `InstructionPhoneticsType.IPA` value.
`extendedSections`	Whether to include road shield and lane limit sections in the response. By default it is equal to the `ExtendedSections.none` value.
`progressPoints`	Whether to include distance and travel time points in the response. By default it is equal to the `ProgressPoints.all` value.


                    
                    
                    init(language:roadShieldReferences:phoneticsType:extendedSections:)

Creates a new GuidanceOptions instance with provided parameters.

Throws

An error of the type GuidanceOptionError.unsupportedCombinationOfOptions

Important

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

Declaration

Swift

public init
    (
        language: Locale = Locale(identifier: "en-US"),
        roadShieldReferences: RoadShieldReferences = .none,
        phoneticsType: InstructionPhoneticsType = .IPA,
        extendedSections: ExtendedSections = .none
    ) throws

Parameters

`language`	The language of the guidance messages. By default it is equal to “en-US”.
`roadShieldReferences`	Whether to include references to road shields in instructions. By default it is equal to the `RoadShieldReferences.none` value.
`phoneticsType`	The format of phonetic instruction transcriptions. By default it is equal to the `InstructionPhoneticsType.IPA` value.
`extendedSections`	Whether to include road shield and lane limit sections in the response. By default it is equal to the `ExtendedSections.none` value.

Public

guidanceVersion
The version of the guidance API to be used. By default it is equal to the OnlineApiVersion.v1 value.

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

public var guidanceVersion: OnlineApiVersion


                    
                    
                    instructionType

The format in which instructions are reported. By default it is equal to the InstructionType.text value.

Declaration

Swift

@available(*, deprecated, message: "This API is deprecated and will be removed with the next major release.")
public var instructionType: InstructionType

language
The locale that defines the language of instructions. e.g. “en-GB”. By default it is equal to “en-US”.
Declaration
Swift

public var language: Locale
roadShieldReferences
Whether to include references to road shields in instructions. By default it is equal to the RoadShieldReferences.none value.
Declaration
Swift

public var roadShieldReferences: RoadShieldReferences


                    
                    
                    announcementPoints

Whether to include announcement points in instructions. By default it is equal to the AnnouncementPoints.none value.

Declaration

Swift

@available(*, deprecated, message: "This API is deprecated and will be removed with the next major release.")
public var announcementPoints: AnnouncementPoints

phoneticsType
The format of phonetic instruction transcriptions. By default it is equal to the InstructionPhoneticsType.none value.
Declaration
Swift

public var phoneticsType: InstructionPhoneticsType
extendedSections
Whether to include road shield, lane, and speed limit sections in the response. By default it is equal to the ExtendedSections.none value.
Declaration
Swift

public var extendedSections: ExtendedSections


                    
                    
                    progressPoints

Whether to include distance and travel time points in the response. By default it is equal to the ProgressPoints.none value.

Declaration

Swift

@available(*, deprecated, message: "This API is deprecated and will be removed with the next major release.")
public var progressPoints: ProgressPoints