GuidanceInstruction

public struct GuidanceInstruction

The GuidanceInstruction class contains information that can be used to guide the driver during navigation.

Important

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

Lifecycle


                    
                    
                    init(uuid:routeOffsetInMeters:travelTimeInSeconds:point:instructionType:street:roadNumbers:countryCode:signpostText:junctionType:turnAngleInDecimalDegrees:exitNumber:roundaboutExitNumber:possibleCombineWithNext:drivingSide:message:combinedMessage:maneuver:verbalMessagePhonetics:verbalMessage:extras:)

Initializer.

Declaration

Swift

public init(
    uuid: UUID = UUID(),
    routeOffsetInMeters: Double,
    travelTimeInSeconds: TimeInterval,
    point: CLLocationCoordinate2D,
    instructionType: InstructionType,
    street: String? = nil,
    roadNumbers: [String]? = nil,
    countryCode: String? = nil,
    signpostText: String? = nil,
    junctionType: JunctionType? = nil,
    turnAngleInDecimalDegrees: Double?,
    exitNumber: String?,
    roundaboutExitNumber: Int?,
    possibleCombineWithNext: Bool,
    drivingSide: DrivingSide? = nil,
    message: String? = nil,
    combinedMessage: String? = nil,
    maneuver: Maneuver,
    verbalMessagePhonetics: Phonetics? = nil,
    verbalMessage: String? = nil,
    extras: [String: AnyObject]? = nil
)


                    
                    
                    init(instruction:)

Initializer.

Declaration

Swift

public init(instruction: Instruction)

Parameters


                                instruction

Instruction object used as a source of data for creating the GuidanceInstruction object.

Public

routeOffsetInMeters
The distance from the start of the route to the point of the instruction
Declaration
Swift

public let routeOffsetInMeters: Double
travelTimeInSeconds
The estimated travel time up to the point corresponding to routeOffsetInMeters.
Declaration
Swift

public let travelTimeInSeconds: TimeInterval
point
The coordinate of the maneuver
Declaration
Swift

public let point: CLLocationCoordinate2D
instructionType
The type of instruction
Declaration
Swift

public let instructionType: InstructionType
street
The street name of the next significant road segment after the maneuver, or of the street that should be followed.
Declaration
Swift

public let street: String?
roadNumbers
The road numbers of the next significant road segment after the maneuver, or of the roads that has to be followed.
Declaration
Swift

public let roadNumbers: [String]?
countryCode
The 3-character ISO 3166-1 alpha-3 country code.
Declaration
Swift

public let countryCode: String?
signpostText
The text on the signpost which is most relevant to the maneuver, or to the direction that should be followed.
Declaration
Swift

public let signpostText: String?
junctionType
The type of the junction where the maneuver takes place.
Declaration
Swift

public let junctionType: JunctionType?
turnAngleInDecimalDegrees
Indicates the direction of an instruction.
Declaration
Swift

public let turnAngleInDecimalDegrees: Double?
exitNumber
The number(s) of a highway exit taken by the current maneuver.
Declaration
Swift

public let exitNumber: String?
roundaboutExitNumber
Indicates which exit to take at a roundabout.
Declaration
Swift

public let roundaboutExitNumber: Int?
possibleCombineWithNext
Indicates whether it is possible to combine the instruction with the next one. This can be used to build messages like “Turn left and then turn right”.
Declaration
Swift

public let possibleCombineWithNext: Bool
drivingSide
Indicates left-hand vs. right-hand side driving at the point of the maneuver.
Declaration
Swift

public let drivingSide: DrivingSide?
message
A human-readable message for the maneuver
Declaration
Swift

public let message: String?
combinedMessage
A human-readable message for the maneuver combined with the message from the next instruction.
Declaration
Swift

public let combinedMessage: String?
maneuver
The type of the maneuver.
Declaration
Swift

public let maneuver: Maneuver
verbalMessagePhonetics
Phonetic transcriptions for the verbal message
Declaration
Swift

public let verbalMessagePhonetics: Phonetics?
verbalMessage
The tagged message to be used for verbal instruction playback.
Declaration
Swift

public let verbalMessage: String?
extras
Additional data related to the instruction. Should be used with maneuver type “OTHER” in order to provide custom maneuver types.
Declaration
Swift

public let extras: [String : AnyObject]?