GoogleNavigation Framework Reference

Type-Definitions

The following type definitions are available globally.

• GMSMapViewNavigationLayoutErrorCode

  Error codes for errors with domain GMSMapViewNavigationLayoutErrorDomain.

  Declaration

  Swift

  struct GMSMapViewNavigationLayoutErrorCode : _ObjectiveCBridgeable, Hashable, Equatable, _SwiftNewtypeWrapper, RawRepresentable, @unchecked Sendable

  Objective-C

  typedef NSInteger GMSMapViewNavigationLayoutErrorCode

• GMSNavigationButtonKnownType

  Experimental feature

  Identifiers for known buttons.

  Note that more identifiers may be added in future NavSDK releases.

  Declaration

  Swift

  struct NavigationButtonKnownType : _ObjectiveCBridgeable, Hashable, Equatable, _SwiftNewtypeWrapper, RawRepresentable, @unchecked Sendable

  Objective-C

  typedef int GMSNavigationButtonKnownType

• GMSNavigationPromptView

  Experimental feature

  Typedef for the prompt views passed to the layout delegate.

  Prompt views are rounded on the top corners by default. This may be altered via the GMSNavigationRoundedCornerView protocol.

  Declaration

  Swift

  typealias NavigationPromptView = any UIView & NavigationRoundedCornerView

  Objective-C

  typedef UIView<GMSNavigationRoundedCornerView> *GMSNavigationPromptView

• GMSNavigationRouteCompletionHandler

  Called when a route from the device’s location to the provided destination(s) is found, or fails to be found for a reason indicated by the GMSNavigationRouteDescription and NSError.

  @related GMSNavigator

  Declaration

  Swift

  typealias GMSNavigationRouteCompletionHandler = ((any NavigationRouteDescription)?, (any Error)?) -> Void

  Objective-C

  typedef void (^GMSNavigationRouteCompletionHandler)(
      id<GMSNavigationRouteDescription> _Nullable, NSError *_Nullable)

  Parameters

  routeDescription	The navigation route description containing route status and metadata if available.
  error	An error object if the routing request failed, or nil if successful.

• GMSTermsResponseCallback

  Called when the user accepts or rejects the terms and conditions.

  For versions >= 5.5.0, termsAccepted will always be YES.

  @related GMSNavigationServices

  Declaration

  Swift

  typealias GMSTermsResponseCallback = (Bool) -> Void

  Objective-C

  typedef void (^GMSTermsResponseCallback)(BOOL)

• GMSNavigationTransactionRecorderErrorHandler

  Declaration

  Swift

  typealias GMSNavigationTransactionRecorderErrorHandler = (any Error) -> Void

  Objective-C

  typedef void (^GMSNavigationTransactionRecorderErrorHandler)(NSError *error)

• GMSRouteInfoCallback

  Called when the route information (ETA and distance) to the provided waypoint is calculated.

  Declaration

  Swift

  typealias GMSRouteInfoCallback = (GMSNavigationRouteInfo?) -> Void

  Objective-C

  typedef void (^GMSRouteInfoCallback)(GMSNavigationRouteInfo *_Nullable)

  Parameters

  routeInfo

  The route information to the given destination. Will be nil if the calculation fails. @related GMSNavigator

• GMSNavigationTransactionIDErrorHandler

  Called if setting transaction IDs through the setTransactionIDs fails. Refer documentation for the API for more details.

  @related GMSNavigator

  Declaration

  Swift

  typealias GMSNavigationTransactionIDErrorHandler = (any Error) -> Void

  Objective-C

  typedef void (^GMSNavigationTransactionIDErrorHandler)(NSError *_Nonnull)

• GMSMapViewPresentReportIncidentPanelErrorCode

  Experimental feature

  Type used to represent error codes for errors that have the domain GMSMapViewPresentReportIncidentPanelErrorDomain.

  Declaration

  Swift

  struct GMSMapViewPresentReportIncidentPanelErrorCode : _ObjectiveCBridgeable, Hashable, Equatable, _SwiftNewtypeWrapper, RawRepresentable, @unchecked Sendable

  Objective-C

  typedef NSInteger GMSMapViewPresentReportIncidentPanelErrorCode

• GMSRouteStatusCallback

  Called when a route from the device’s location to the provided destination(s) is found, or fails to be found for a reason indicated by the RouteStatus.

  @related GMSNavigator

  Declaration

  Swift

  typealias GMSRouteStatusCallback = (GMSRouteStatus) -> Void

  Objective-C

  typedef void (^GMSRouteStatusCallback)(GMSRouteStatus)

• GMSSetDestinationCompletionHandler

  Called when a route from the device’s location to the provided destination(s) is found, or fails to be found for a reason indicated by the routeStatus.

  @related GMSNavigator

  Declaration

  Swift

  typealias GMSSetDestinationCompletionHandler = (GMSNavigationWaypoint?, GMSRouteStatus) -> Void

  Objective-C

  typedef void (^GMSSetDestinationCompletionHandler)(
      GMSNavigationWaypoint *_Nullable, GMSRouteStatus)

  Parameters

  destination	The destination waypoint, if available.
  routeStatus	This value will be .OK if a route was successfully determined; otherwise, it will indicate the reason for failure.

• GMSFeatureType

  Identifiers for feature types of data-driven styling features.

  Declaration

  Swift

  struct FeatureType : _ObjectiveCBridgeable, Hashable, Equatable, _SwiftNewtypeWrapper, RawRepresentable, @unchecked Sendable

  Objective-C

  typedef NSString *GMSFeatureType

• GMSReverseGeocodeCallback

  Handler that reports a reverse geocoding response, or error.

  @related GMSGeocoder

  Declaration

  Swift

  typealias GMSReverseGeocodeCallback = (GMSReverseGeocodeResponse?, (any Error)?) -> Void

  Objective-C

  typedef void (^GMSReverseGeocodeCallback)(GMSReverseGeocodeResponse *_Nullable,
                                            NSError *_Nullable)

• GMSMapPoint

  A point on the map. May represent a projected coordinate.

  x is in [-1, 1]. The axis direction is normal: y grows towards North, x grows towards East. (0, 0) is the center of the map.

  See GMSProject() and GMSUnproject().

  Declaration

  Objective-C

  typedef struct GMSMapPoint GMSMapPoint

• GMSOrientation

  GMSOrientation is a tuple of heading and pitch used to control the viewing direction of a GMSPanoramaCamera.

  Declaration

  Objective-C

  typedef struct GMSOrientation GMSOrientation

• GMSPanoramaCallback

  Callback for when a panorama metadata becomes available. If an error occurred, panorama is nil and error is not nil. Otherwise, panorama is not nil and error is nil.

  @related GMSPanoramaService

  Declaration

  Swift

  typealias GMSPanoramaCallback = (GMSPanorama?, (any Error)?) -> Void

  Objective-C

  typedef void (^GMSPanoramaCallback)(GMSPanorama *_Nullable, NSError *_Nullable)

• GMSVisibleRegion

  GMSVisibleRegion contains the four points defining the polygon that is visible in a map’s camera.

  This polygon can be a trapezoid instead of a rectangle, because a camera can have tilt. If the camera is directly over the center of the camera, the shape is rectangular, but if the camera is tilted, the shape will appear to be a trapezoid whose smallest side is closest to the point of view.

  Declaration

  Objective-C

  typedef struct GMSVisibleRegion GMSVisibleRegion

• GMSTileURLConstructor

  GMSTileURLConstructor is a block taking x, y and zoom and returning an NSURL, or nil to indicate no tile for that location.

  @related GMSURLTileLayer

  Declaration

  Swift

  typealias GMSTileURLConstructor = (UInt, UInt, UInt) -> URL?

  Objective-C

  typedef NSURL *_Nullable (^GMSTileURLConstructor)(NSUInteger, NSUInteger,
                                                    NSUInteger)