TriggeringPoint

public struct TriggeringPoint : Hashable, Equatable

Defines a point on the route, where a trigger should be exposed.

Triggering point is associated with TriggerType based on distance to the maneuver. For example, the following trigger must be triggered on the route at least 13 kilometers or at most 10 kilometers to the maneuver point.

 TriggeringPoint(
       recommendedDistance: TriggeringDistances(
           defaultDistance: Measurement.tt.kilometers(10.0)
       ),
       earliestDistance: TriggeringDistances(
           defaultDistance: Measurement.tt.kilometers(13.0)
       ),
       recommendedTime: 370,
       messageDuration: 0,
       isAudible: false
  )

Important

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

Lifecycle

  • Creates a triggering point associating with the specified parameters.

    Declaration

    Swift

    public init(
    recommendedDistance: TriggeringDistances,
    earliestDistance: TriggeringDistances? = nil,
    recommendedTime: TimeInterval? = nil,
    earliestTime: TimeInterval? = nil,
    messageDuration: TimeInterval? = nil,
    retriggeringPeriod: TimeInterval? = nil,
    isAudible: Bool = true
)

    Parameters

    recommendedDistance

    Recommended triggering distance.
    earliestDistance

    Earliest triggering distance.
    recommendedTime

    Recommended triggering time.
    earliestTime

    Earliest triggering time.
    messageDuration

    Approximate duration of announcement message.
    retriggeringPeriod

    Retriggering period.
    isAudible

    Defines whether audio announcement should be performed.

Public

  • Declaration

    Swift

    public static func == (lhs: TriggeringPoint, rhs: TriggeringPoint) -> Bool

  • Declaration

    Swift

    public func hash(into hasher: inout Hasher)