Get Started Contact sales

GoogleNavigation Framework Reference

GMSNavigationRouteTokenResolvedParameters

@protocol GMSNavigationRouteTokenResolvedParameters <NSObject>

Resolved routing parameters embedded within a precomputed route token and applied by the backend routing engine.

  • Indicates whether tolls are avoided on the route.

    Declaration

    Swift

    var avoidTolls: Bool { get }

    Objective-C

    @property (nonatomic, readonly) BOOL avoidTolls;

  • Indicates whether highways are avoided on the route.

    Declaration

    Swift

    var avoidHighways: Bool { get }

    Objective-C

    @property (nonatomic, readonly) BOOL avoidHighways;

  • Indicates whether ferries are avoided on the route.

    Declaration

    Swift

    var avoidFerries: Bool { get }

    Objective-C

    @property (nonatomic, readonly) BOOL avoidFerries;

  • Indicates whether tunnels are avoided on the route.

    Declaration

    Swift

    var avoidTunnels: Bool { get }

    Objective-C

    @property (nonatomic, readonly) BOOL avoidTunnels;

  • List of countries where toll vignettes are avoided on the route, specified as Unicode CLDR two-letter region codes (e.g., “CH” for Switzerland, “AT” for Austria).

    Declaration

    Swift

    var avoidVignettes: [String] { get }

    Objective-C

    @property (nonatomic, copy, readonly) NSArray<NSString *> *_Nonnull avoidVignettes;

  • The time tolerance window (in seconds) by which an alternative route must be faster to trigger a reroute recommendation.

    Declaration

    Swift

    var betterRouteTimeTolerance: TimeInterval { get }

    Objective-C

    @property (nonatomic, readonly) NSTimeInterval betterRouteTimeTolerance;

  • The reroute strategy applied by the routing backend.

    Declaration

    Swift

    var rerouteStrategy: NavigationRerouteStrategy { get }

    Objective-C

    @property (nonatomic, readonly) GMSNavigationRerouteStrategy rerouteStrategy;

  • The travel mode that the routing backend actually used for the route.

    This may differ from the travel mode requested on the navigation session, because the backend applies the routing parameters encoded in the precomputed route token. tokenExecutionStatus is computed without reference to travel mode, so a successfully applied token does not by itself confirm which mode was used; this property is how to check.

    Any value other than GMSNavigationTravelModeDriving is a faithful report of the mode the backend used. GMSNavigationTravelModeDriving is less specific: it is also reported when the backend used a mode that has no GMSNavigationTravelMode equivalent, and when the backend did not report a travel mode at all. It therefore does not on its own prove that the route was computed for driving.

    Declaration

    Swift

    var travelMode: GMSNavigationTravelMode { get }

    Objective-C

    @property (nonatomic, readonly) GMSNavigationTravelMode travelMode;