Get Started Contact sales

GoogleNavigation Framework Reference

GMSNavigationRouteDescription

@protocol GMSNavigationRouteDescription <NSObject>

Encapsulates the result of a setDestinations request, wrapping the route status and, on failure, an error describing what went wrong.

@related GMSNavigator

  • The status of the route request. See GMSRouteStatus for possible values.

    Declaration

    Swift

    var routeStatus: GMSRouteStatus { get }

    Objective-C

    @property (nonatomic, readonly) GMSRouteStatus routeStatus;

  • An error describing the failure when routeStatus is any value other than GMSRouteStatusOK, or nil when the route request succeeds (GMSRouteStatusOK). Check error != nil (or routeStatus != GMSRouteStatusOK) to detect failures.

    Declaration

    Swift

    var error: (any Error)? { get }

    Objective-C

    @property (nonatomic, readonly, nullable) NSError *error;

  • Route token execution metadata returned by the routing engine when navigating with a precomputed route token, including token application status and effective routing parameters.

    nil if execution details were not provided by the server, or if the request failed.

    Declaration

    Swift

    var routeTokenExecutionDetails: (any NavigationRouteTokenExecutionDetails)? { get }

    Objective-C

    @property (nonatomic, readonly, nullable) id<GMSNavigationRouteTokenExecutionDetails> routeTokenExecutionDetails;