reverseGeocodeLocation(_:completionHandler:)

Submits a reverse-geocoding request for the specified location.

Declaration

func reverseGeocodeLocation(_ location: CLLocation, completionHandler: @escaping  @Sendable ([CLPlacemark]?, (any Error)?) -> Void)

func reverseGeocodeLocation(_ location: CLLocation) async throws -> [CLPlacemark]

Parameters

location:
The location object containing the coordinate data to look up.
completionHandler:
The handler block to execute with the results. The geocoder executes this handler regardless of whether the request was successful or unsuccessful. For more information on the format of this block, see Clgeocodecompletionhandler.

Mentioned in

Converting between coordinates and user-friendly place names

Discussion

important:

You can call this method from synchronous code using a completion handler, as shown on this page, or you can call it as an asynchronous method that has the following declaration:

func reverseGeocodeLocation(_ location: CLLocation) async throws -> [CLPlacemark]

For information about concurrency and asynchronous code in Swift, see Calling Objective-C APIs Asynchronously.

This method submits the specified location data to the geocoding server asynchronously and returns. When the request completes, the geocoder executes the provided completion handler on the main thread.

After initiating a reverse-geocoding request, do not attempt to initiate another reverse- or forward-geocoding request. Geocoding requests are rate-limited for each app, so making too many requests in a short period of time may cause some of the requests to fail. When the maximum rate is exceeded, the geocoder passes an error object with the value CLError.Code.network to your completion handler.