GuidanceOptions

public struct GuidanceOptions

Specifies options related to instructions.

Important

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

Lifecycle


                    
                    
                    init(guidanceVersion:instructionsType:language:roadShieldReferences:announcementPoints:phonetics:extendedSections:progressPoints:)

Declaration

Swift

public init
    (
        guidanceVersion: GuidanceOnlineApiVersion = .v1,
        instructionsType: InstructionsType? = nil,
        language: String? = nil,
        roadShieldReferences: RequestedRoadShieldReferences? = nil,
        announcementPoints: AnnouncementPoints? = nil,
        phonetics: InstructionPhoneticsType? = nil,
        extendedSections: ExtendedSections? = nil,
        progressPoints: ProgressPoints? = nil
    ) throws

Parameters

`guidanceVersion`	The version of the guidance API to be used.
`instructionType`	The format in which instructions are reported.
`language`	The language of the guidance messages.
`roadShieldReferences`	Whether to include references to road shields in instructions.
`announcementPoints`	Whether to include announcement points in instructions.
`phonetics`	The format of phonetic instruction transcriptions.
`extendedSections`	Whether to include road shield, lane, and speed limit sections in the response.
`progressPoints`	Whether to include distance and travel time points in the response.

Public

guidanceVersion
The version of the guidance API to be used.
Declaration
Swift

public let guidanceVersion: GuidanceOnlineApiVersion
instructionsType
The format in which instructions are reported.
Declaration
Swift

public let instructionsType: InstructionsType?
language
The language of instructions as an IETF language tag, e.g. “en-GB”.
Declaration
Swift

public let language: String?
roadShieldReferences
Whether to include references to road shields in instructions.
Declaration
Swift

public let roadShieldReferences: RequestedRoadShieldReferences?
announcementPoints
Whether to include announcement points in instructions.
Declaration
Swift

public let announcementPoints: AnnouncementPoints?
phonetics
The format of phonetic instruction transcriptions.
Declaration
Swift

public let phonetics: InstructionPhoneticsType?
extendedSections
Whether to include road shield, lane, and speed limit sections in the response.
Declaration
Swift

public let extendedSections: ExtendedSections?
progressPoints
Whether to include distance and travel time points in the response.
Declaration
Swift

public let progressPoints: ProgressPoints?

GuidanceOptions


                    
                    
                    copy(build:)

Copies the current GuidanceOptions with changes specified in build closure

Declaration

Swift

public func copy(build: (inout Builder) throws -> ()) throws -> GuidanceOptions

Parameters


                                build

This closure allows for change of GuidanceOptions values

Return Value

GuidanceOptions with the changes set on the closure

Builder
The Builder creates a new instance of GuidanceOptions with modified fields.
Declaration
Swift

public struct Builder