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.-
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.
-
The version of the guidance API to be used.
Declaration
Swift
public let guidanceVersion: GuidanceOnlineApiVersion
-
The format in which instructions are reported.
Declaration
Swift
public let instructionsType: InstructionsType?
-
The language of instructions as an IETF language tag, e.g. “en-GB”.
Declaration
Swift
public let language: String?
-
Whether to include references to road shields in instructions.
Declaration
Swift
public let roadShieldReferences: RequestedRoadShieldReferences?
-
Whether to include announcement points in instructions.
Declaration
Swift
public let announcementPoints: AnnouncementPoints?
-
The format of phonetic instruction transcriptions.
Declaration
Swift
public let phonetics: InstructionPhoneticsType?
-
Whether to include road shield, lane, and speed limit sections in the response.
Declaration
Swift
public let extendedSections: ExtendedSections?
-
Whether to include distance and travel time points in the response.
Declaration
Swift
public let progressPoints: ProgressPoints?
-
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
-
The
Builder
creates a new instance ofGuidanceOptions
with modified fields.Declaration
Swift
public struct Builder