GooglePlacesSwift Framework Reference

AI-generated Key Takeaways

• This documentation details globally available protocols within the Places SDK for iOS.

• These protocols provide functionality for tasks such as fetching App Check tokens, defining coordinate regions, and interacting with the Places SDK.

• Some protocols, like CoordinateRegionBias and CoordinateRegionRestriction, should not be conformed to by external types to avoid errors.

• The PlacesClientProtocol is the primary interface for using the Places SDK, offering methods for searching and retrieving place details.

• All interactions with the Places SDK, including calls to PlacesClient methods, should occur on the main thread for stability and predictable behavior.

Protocols

The following protocols are available globally.

• AISummary

  Protocol for the AI-generated summary of the place.

  Declaration

  Swift

  protocol AISummary : CustomStringConvertible, Hashable, Sendable

• AppCheckTokenProvider

  A protocol for fetching the App Check token.

  Declaration

  Swift

  protocol AppCheckTokenProvider : Sendable

• ConsumerAlertProtocol

  Declaration

  Swift

  protocol ConsumerAlertProtocol : CustomStringConvertible, Hashable, Sendable

• CoordinateRegion

  Specifies coordinate region information.

  Declaration

  Swift

  protocol CoordinateRegion : Hashable

• CoordinateRegionBias

  Specifies that the coordinate region can be used as a search bias.

  Warning

  This should not be conformed to by types outside of GooglePlacesSwift. Doing so may result in a fatal error.

  Declaration

  Swift

  protocol CoordinateRegionBias : CoordinateRegion

• CoordinateRegionRestriction

  Specifies that the coordinate region can be used as a search restriction.

  Warning

  This should not be conformed to by types outside of GooglePlacesSwift. Doing so may result in a fatal error.

  Declaration

  Swift

  protocol CoordinateRegionRestriction : CoordinateRegion

• PlaceProtocol

  Declaration

  Swift

  protocol PlaceProtocol : CustomStringConvertible, Hashable, Sendable

• PlacesClientProtocol

  Main interface to the Places SDK, used for searching and getting details about places.

  This type should be accessed through PlacesClient.shared.

  PlacesClient methods should only be called from the main thread. Calling these methods from another thread will result in an exception or undefined behavior. Unless otherwise specified, all callbacks will be invoked on the main thread.

  Declaration

  Swift

  protocol PlacesClientProtocol : AnyObject, Sendable