TomTom SDK for iOS GuidanceUpdateEvent

GuidanceUpdateEvent

public enum GuidanceUpdateEvent

Represents guidance update events.

The enumeration is a parameter of TomTomSDKNavigation/NavigationEvent/guidanceUpdateEvent(_:) which is called when guidance update occurs.

  • Indicates the instructions are updated.

    Declaration

    Swift

    case didUpdateInstructions(instructions: [GuidanceInstruction])

    Parameters

    instructions

    The ordered list of next instructions along the route. The number of instructions provided is determined by the internal threshold.

  • Indicates an announcement is generated.

    Declaration

    Swift

    case didGenerateAnnouncement(announcement: GuidanceAnnouncement, shouldPlay: Bool)

    Parameters

    announcement

    Announcement about the upcoming maneuver.
    shouldPlay

    Whether announcement should be triggered according to guidelines.

  • Indicates the distance to next instruction is updated.

    Declaration

    Swift

    case didUpdateDistanceToNextInstruction(
    distance: Measurement<UnitLength>,
    instructions: [GuidanceInstruction],
    currentPhase: InstructionPhase
)

    Parameters

    distance

    The updated distance to the next instruction. This provides the remaining distance to the next instruction.
    instructions

    The ordered list of next instructions along the route. The number of instructions provided is determined by the internal threshold.
    currentPhase

    The current phase of the instruction. The value indicates the stage of the current instruction.