GuidanceUpdatedEvent
public enum GuidanceUpdatedEvent
Represents guidance update events.
The enumeration is a parameter of guidanceUpdatedEvent(_:)
which is triggered when guidance update occurs.
-
Indicates the instructions are updated.
Declaration
Swift
case didUpdateInstructions([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(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(Measurement<UnitLength>, [GuidanceInstruction], 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.
phase
The current phase of the instruction. The value indicates the stage of the current instruction.