Referencia de la clase GMSPlacesClient


Descripción general

Es la interfaz principal del SDK de Places.

Se usa para buscar y obtener detalles sobre los lugares. Se debe acceder a esta clase a través del método [GMSPlacesClient sharedClient].

GMSPlacesClient solo debe llamarse desde el subproceso principal. Si llamas a estos métodos desde otro subproceso, se generará una excepción o un comportamiento indefinido. A menos que se especifique lo contrario, todas las devoluciones de llamada se invocarán en el subproceso principal.

Funciones de los miembros públicos

(vacío)- lookUpPlaceID:devolución de llamada:
 Obtén detalles de un lugar.
(vacío)- fetchAutocompleteSuggestionsFromRequest:callback:
 Encuentra sugerencias de Autocomplete a partir de una consulta de texto.
(vacío)- lookUpPhotosForPlaceID:devolución de llamada:
 Obtiene los metadatos de hasta 10 fotos asociadas con un lugar.
(vacío)- loadPlacePhoto:callback:
 Carga la imagen de una foto específica en su tamaño máximo.
(vacío)- loadPlacePhoto:constrainedToSize:scale:callback:
 Carga la imagen de una foto específica, a escala para ajustarse a las dimensiones máximas especificadas.
(vacío)- currentPlaceWithCallback:
 Devuelve una estimación del lugar donde se sabe que se encuentra el dispositivo actualmente.
(vacío)- findAutocompletePredictionsFromQuery:filter:sessionToken:callback:
 Encontrar predicciones de Autocomplete a partir de una consulta de texto
(vacío)- fetchPlaceFromPlaceID:placeFields:sessionToken:callback:
 Obtén detalles de un lugar.
(vacío)- findPlaceLikelihoodsFromCurrentLocationWithPlaceFields:callback:
 Encuentra probabilidades de lugares con la ubicación actual del usuario.
(vacío)- isOpenWithRequest:callback:
 Obtiene el estado abierto de un lugar.
(vacío)- isOpenWithPlaceID:callback:
 Obtiene los detalles de un lugar, incluidos todos los campos necesarios para determinar GMSPlaceOpenStatus en la hora actual.
(vacío)- isOpenWithPlaceID:date:callback:
 Obtiene detalles de un lugar, incluidos todos los campos necesarios para determinar GMSPlaceOpenStatus en el NSDate especificado.
(vacío)- isOpenWithPlace:callback:
 Obtiene los detalles de un lugar, incluidos todos los campos necesarios para determinar GMSPlaceOpenStatus en la hora actual.
(vacío)- isOpenWithPlace:date:callback:
 Obtiene detalles de un lugar, incluidos todos los campos necesarios para determinar GMSPlaceOpenStatus en el NSDate especificado.
(vacío)- searchByTextWithRequest:callback:
 Busca lugares por texto y restricciones.
(vacío)- fetchPlaceWithRequest:callback:
 Obtén un sitio mediante un objeto de solicitud.
(vacío)- fetchPhotoWithRequest:callback:
 Solicitar una foto mediante la solicitud para recuperar fotos
(vacío)- searchNearbyWithRequest:callback:
 Busca lugares cerca de una ubicación y una restricción.

Funciones estáticas de miembros públicos

(instancetype)+ sharedClient
 Proporciona la instancia compartida de GMSPlacesClient para el SDK de Google Places para iOS y su creación si es necesario.
(BOOL)+ ProvideAPIKey:
 Proporciona tu clave de API al SDK de Google Places para iOS.
(NSString *)+ openSourceLicenseInfo
 Devuelve la información de licencia de software de código abierto para el SDK de Google Places para iOS.
(NSString *)+ SDKVersion
 Muestra la versión de esta versión del SDK de Google Places para iOS.
(NSString *)+ SDKLongVersion
 Muestra la versión larga de esta versión del SDK de Google Places para iOS.

(Ten en cuenta que estas no son funciones de los miembros).

typedef void(^)GMSPlaceResultCallback )(GMSPlace *_Resultado NULL, error NSError *_Nullable)
 Tipo de devolución de llamada para recibir búsquedas de detalles de lugares.
typedef void(^)GMSPlaceLikelihoodListCallback )(GMSPlaceLikelihoodList *_Nullable likelihoodList, NSError *_Nullable error)
 Tipo de devolución de llamada para recibir listas de probabilidades de lugares.
typedef void(^)GMSPlaceLikelihoodsCallback )(NSArray< GMSPlaceLikelihood * > *_Nullable probabilidads, NSError *_Nullable error)
 Tipo de devolución de llamada para recibir un array de GMSPlaceLikelihood.
typedef void(^)GMSAutocompletePredictionsCallback )(NSArray< GMSAutocompletePrediction * > *_Nullable results, NSError *_Nullable error)
 Tipo de devolución de llamada para recibir resultados de autocompletado.
typedef void(^)GMSPlacePhotoMetadataResultCallback )(GMSPlacePhotoMetadataList *_Nullable photos, NSError *_Nullable error)
 Tipo de devolución de llamada para recibir resultados de fotos de lugares.
typedef void(^)GMSPlacePhotoImageResultCallback )(UIImage *_Nullable photo, NSError *_Nullable error)
 Tipo de devolución de llamada para recibir objetos UIImage desde un objeto GMSPlacePhotoMetadata.
typedef void(^)GMSPlaceOpenStatusCallback )(resultado GMSPlaceOpenStatus, error NSError *_Nullable)
 Tipo de devolución de llamada para recibir el estado del horario de atención del lugar.
typedef void(^)GMSPlaceOpenStatusResponseCallback )(GMSPlaceIsOpenResponse *response, NSError *_Nullable error)
 Tipo de devolución de llamada para recibir la respuesta de estado abierto.
typedef void(^)GMSPlaceSearchByTextResultCallback )(NSArray< GMSPlace * > *_Nullable places, NSError *_Nullable error)
 Tipo de devolución de llamada para recibir resultados de búsqueda por texto.
typedef void(^)GMSFetchPhotoResultCallback )(UIImage *_Nullable photoImage, NSError *_Nullable error)
 Tipo de devolución de llamada para recibir una foto.
typedef void(^)GMSAutocompleteSuggestionsCallback )(NSArray< GMSAutocompleteSuggestion * > *_Nullable results, NSError *_Nullable error)
 Tipo de devolución de llamada para resultados de autocompletar.
typedef void(^)GMSPlaceSearchNearbyResultCallback )(NSArray< GMSPlace * > *_Nullable places, NSError *_Nullable error)
 Tipo de devolución de llamada para recibir resultados de búsqueda cercanos.

Documentación de la función de miembro

+ (tipo de instancia) sharedClient

Proporciona la instancia compartida de GMSPlacesClient para el SDK de Google Places para iOS y su creación si es necesario.

Si tu aplicación a menudo usa métodos de GMSPlacesClient, es posible que quieras conservar este objeto directamente, ya que, de lo contrario, es posible que tu conexión a Google se reinicie de forma periódica.

+ (BOOL) providedAPIKey: (NSString *) key

Proporciona tu clave de API al SDK de Google Places para iOS.

Esta clave se genera para tu aplicación a través de la consola de Google Cloud Platform y se sincroniza con el ID del paquete de tu aplicación para identificarla. Tu aplicación debe llamar a este método antes de usar GMSPlacesClient (p.ej., en application:didFinishLaunchingWithOptions:).

Muestra:
SÍ, si la APIKey se proporcionó correctamente.
+ (NSString *) openSourceLicenseInfo

Devuelve la información de licencia de software de código abierto para el SDK de Google Places para iOS.

Esta información debe estar disponible en tu aplicación.

+ (NSString *) SDKVersion

Muestra la versión de esta versión del SDK de Google Places para iOS.

de Google Cloud. Por ejemplo, “1.0.0”.

+ (NSString *) SDKLongVersion

Muestra la versión larga de esta versión del SDK de Google Places para iOS.

de Google Cloud. Por ejemplo, “1.0.0 (102.1)".

- (void) lookUpPlaceID: (NSString *) placeID
devolución de llamada: (GMSPlaceResultCallback) devolución de llamada

Obtén detalles de un lugar.

Este método no genera bloqueos.

Parámetros:
placeIDEl ID de lugar que se buscará.
callbackLa devolución de llamada que se invocará con el resultado de la búsqueda.
Nota:
Esto dejó de estar disponible. fetchPlaceWithRequest:callback: reemplazó este método y se quitará en una versión futura.
- (void) retrieveAutocompleteSuggestionsFromRequest: (GMSAutocompleteRequest *) solicitud
devolución de llamada: (GMSAutocompleteSuggestionsCallback) devolución de llamada

Encuentra sugerencias de Autocomplete a partir de una consulta de texto.

De manera opcional, los resultados pueden estar sesgados hacia una ubicación determinada o restringidos a un área. Este método no genera bloqueos.

Se invocará la devolución de llamada proporcionada con una matriz de sugerencias de autocompletado si se realiza de forma correcta y con NSError si se produce un error.

Parámetros:
requestLa solicitud GMSAutocompleteRequest para autocompletar.
callbackLa devolución de llamada que se invocará con las sugerencias.
- (void) lookUpPhotosForPlaceID: (NSString *) placeID
devolución de llamada: (GMSPlacePhotoMetadataResultCallback). devolución de llamada

Obtiene los metadatos de hasta 10 fotos asociadas con un lugar.

Las fotos provienen de diversas ubicaciones, como de los propietarios de las empresas y de las fotos que aportan los usuarios de Google+. En la mayoría de los casos, estas fotos se pueden usar sin atribución o tendrán la atribución requerida incluida como parte de la imagen. Sin embargo, debes usar la propiedad attributions en la respuesta para recuperar las atribuciones adicionales requeridas y mostrarlas en tu aplicación siempre que muestres la imagen. Se devuelve un máximo de 10 fotos.

Es probable que varias llamadas con este método muestren las mismas fotos cada vez. Sin embargo, esto no está garantizado debido a que los datos subyacentes pueden haber cambiado.

Este método realiza una búsqueda de red.

Parámetros:
placeIDEs el ID de lugar para el que se buscan las fotos.
callbackLa devolución de llamada que se invocará con el resultado de la búsqueda.
- (void) loadPlacePhoto: (GMSPlacePhotoMetadata *) photoMetadata
devolución de llamada: (GMSPlacePhotoImageResultCallback). devolución de llamada

Carga la imagen de una foto específica en su tamaño máximo.

El SDK puede almacenar en caché los datos de imágenes. Si la foto solicitada no existe en la caché, se realizará una búsqueda de red.

Parámetros:
photoMetadataEl GMSPlacePhotoMetadata para el que se carga un UIImage.
callbackLa devolución de llamada que se invocará con el UIImage cargado.
- (void) loadPlacePhoto: (GMSPlacePhotoMetadata *) photoMetadata
constrainedToSize: (CGSize) maxSize
escala: (CGFloat) escala
devolución de llamada: (GMSPlacePhotoImageResultCallback). devolución de llamada

Carga la imagen de una foto específica, a escala para ajustarse a las dimensiones máximas especificadas.

El tamaño de la imagen se ajustará para adaptarse a las dimensiones determinadas y, al mismo tiempo, mantener la relación de aspecto de la imagen original. Este escalamiento se realiza del lado del servidor.

Si el parámetro de escala no es 1.0 maxSize se multiplicará por este valor y el UIImage que se muestre se configurará para tener la escala especificada. Este parámetro se debe establecer en la escala de pantalla si cargas imágenes para mostrarlas en la pantalla.

El SDK puede almacenar en caché los datos de imágenes. Si la foto solicitada no existe en la caché, se realizará una búsqueda de red.

Nota:
Después de aplicar el factor de escala, las dimensiones en maxSize se redondearán al número entero más cercano antes de usarlas. Si se solicita una imagen que supera el tamaño máximo disponible, es posible que se muestre una imagen más pequeña.
Parámetros:
photoMetadataEl GMSPlacePhotoMetadata para el que se carga un UIImage.
maxSizeEl tamaño máximo de la imagen.
de Google.Es la escala en la que se cargará la imagen.
callbackLa devolución de llamada que se invocará con el UIImage cargado.

Devuelve una estimación del lugar donde se sabe que se encuentra el dispositivo actualmente.

Genera una lista de probabilidades de lugares según la última ubicación estimada del dispositivo. Se invocará la devolución de llamada proporcionada con esta lista de probabilidades si se ejecuta de forma correcta y con un NSError si se produce un error.

Nota:
Este método requiere que la app tenga permiso para acceder a la ubicación actual del dispositivo. Antes de llamar a este método, asegúrate de solicitar acceso a la ubicación del usuario con [CLLocationManager requestWhenInUseAuthorization] o [CLLocationManager requestalwaysAuthorization]. Si llamas a este método y tu app no tiene el estado de autorización correcto, se realizará una llamada a la devolución de llamada con un error.
Parámetros:
callbackLa devolución de llamada que se invocará con la lista de probabilidad de sitios.
- (void) findAutocompletePredictionsFromQuery: (NSString *) query
filtro: (GMSAutocompleteFilter anulable *) filtro
sessionToken: (GMSAutocompleteSessionToken anulable *) sessionToken
devolución de llamada: (GMSAutocompletePredictionsCallback) devolución de llamada

Encontrar predicciones de Autocomplete a partir de una consulta de texto

De manera opcional, los resultados pueden estar sesgados hacia una ubicación determinada o restringidos a un área. Este método no genera bloqueos.

Se invocará la devolución de llamada proporcionada con una matriz de predicciones de autocompletado si se realiza de manera correcta y con NSError si se produce un error.

Parámetros:
consultaTexto parcial que se debe autocompletar.
filterEl filtro que se aplica a los resultados. Este parámetro puede ser nulo.
sessionTokenEl GMSAutocompleteSessionToken para asociar la solicitud a una sesión de facturación.
callbackLa devolución de llamada que se invocará con las predicciones.
- (void) retrievePlaceFromPlaceID: (NSString *) placeID
placeFields: (GMSPlaceField). placeFields
sessionToken: (GMSAutocompleteSessionToken anulable *) sessionToken
devolución de llamada: (GMSPlaceResultCallback) devolución de llamada

Obtén detalles de un lugar.

Este método no genera bloqueos.

Parámetros:
placeIDEl ID de lugar que se buscará.
placeFieldsSon los campos de lugar individuales solicitados para los objetos de lugar de la lista.
sessionTokenEl GMSAutocompleteSessionToken para asociar la solicitud a una sesión de facturación.
callbackLa devolución de llamada que se invocará con el resultado de la búsqueda.
Nota:
Esto dejó de estar disponible. fetchPlaceWithRequest:callback: callback: reemplazó este método y se quitará en una versión futura.
- (void) findPlaceLikelihoodsFromCurrentLocationWithPlaceFields: (GMSPlaceField). placeFields
devolución de llamada: (GMSPlaceLikelihoodsCallback) devolución de llamada

Encuentra probabilidades de lugares con la ubicación actual del usuario.

Este método no genera bloqueos.

Se invocará la devolución de llamada proporcionada con un conjunto de sitios con puntajes de probabilidad si se tiene éxito y un NSError cuando se produce un error.

Parámetros:
placeFieldsSon los campos de lugar individuales solicitados para los objetos de lugar de la lista.
callbackLa devolución de llamada que se invocará con las probabilidades de sitios.
- (void) isOpenWithRequest: (GMSPlaceIsOpenRequest *) isOpenRequest
devolución de llamada: (GMSPlaceOpenStatusResponseCallback) devolución de llamada

Obtiene el estado abierto de un lugar, incluidas todas las propiedades necesarias para determinar GMSPlaceOpenStatus en la NSDate especificada. Este método no genera bloqueos.

Parámetros:
isOpenRequestEs la solicitud para determinar el estado de un lugar determinado.
callbackLa devolución de llamada que se invocará con la respuesta de estado abierta.
- (void) isOpenWithPlaceID: (NSString *) placeID
devolución de llamada: (GMSPlaceOpenStatusCallback). devolución de llamada

Obtiene el estado abierto de un lugar, incluidos todos los campos necesarios para determinar GMSPlaceOpenStatus en la hora actual.

Este método no genera bloqueos.

Parámetros:
placeIDEl ID de lugar que se buscará.
callbackEs la devolución de llamada que se invocará con el resultado del sitio.
- (void) isOpenWithPlaceID: (NSString *) placeID
Fecha: (NSDate *) date
devolución de llamada: (GMSPlaceOpenStatusCallback). devolución de llamada

Obtiene el estado abierto de un lugar, incluidos todos los campos necesarios para determinar GMSPlaceOpenStatus en el NSDate especificado.

Este método no genera bloqueos.

Parámetros:
placeIDEl ID de lugar que se buscará.
fechaEl objeto NSDate para el que se determina el estado abierto.
callbackEs la devolución de llamada que se invocará con el resultado del sitio.
- (void) isOpenWithPlace: (GMSPlace *) lugar
devolución de llamada: (GMSPlaceOpenStatusCallback). devolución de llamada

Obtiene el estado abierto de un lugar, incluidos todos los campos necesarios para determinar GMSPlaceOpenStatus en la hora actual.

Solo solicita campos adicionales si GMSPlace no tiene todos los campos necesarios; de lo contrario, se mostrará GMSPlaceOpenStatus en la devolución de llamada de inmediato. Este método no genera bloqueos.

Parámetros:
lugarEl GMSPlace que se buscará.
callbackEs la devolución de llamada que se invocará con el resultado del sitio.
- (void) isOpenWithPlace: (GMSPlace *) lugar
Fecha: (NSDate *) date
devolución de llamada: (GMSPlaceOpenStatusCallback). devolución de llamada

Obtiene detalles de un lugar, incluidos todos los campos necesarios para determinar GMSPlaceOpenStatus en el NSDate especificado.

Solo solicita campos adicionales si GMSPlace no tiene todos los campos necesarios; de lo contrario, GMSPlaceOpenStatus\ will be returned in the callback immediately. This method is non-blocking.

Parameters:
placeThe GMSPlace to lookup.
dateThe NSDate to determine open status for.
callbackThe callback to invoke with the place result.

- (void) searchByTextWithRequest: (GMSPlaceSearchByTextRequest *) textSearchRequest
devolución de llamada: (GMSPlaceSearchByTextResultCallback) devolución de llamada

Busca lugares por texto y restricciones.

Este método no genera bloqueos.

Parámetros:
textSearchRequestGMSPlaceSearchByTextRequest Es la solicitud de texto que se usará para la consulta.
callbackLa devolución de llamada que se invocará con el resultado de la búsqueda.
- (void) retrievePlaceWithRequest: (GMSFetchPlaceRequest *) fetchPlaceRequest
devolución de llamada: (GMSPlaceResultCallback) devolución de llamada

Obtén un sitio mediante un objeto de solicitud.

Este método no genera bloqueos.

Parámetros:
fetchPlaceRequestGMSFetchPlaceRequest: Es la solicitud de recuperación de lugar que se usará para la consulta.
callbackEs la devolución de llamada que se invocará con el resultado del sitio.
- (void) retrievePhotoWithRequest: (GMSFetchPhotoRequest *) fetchPhotoRequest
devolución de llamada: (GMSFetchPhotoResultCallback) devolución de llamada

Solicitar una foto mediante la solicitud para recuperar fotos

Este método no genera bloqueos.

Parámetros:
fetchPhotoRequestGMSFetchPhotoRequest Es la solicitud de foto que se debe usar.
callbackEs la devolución de llamada que se invocará con el resultado NSURL.
- (void) searchNearbyWithRequest: (GMSPlaceSearchNearbyRequest *) searchNearbyRequest
devolución de llamada: (GMSPlaceSearchNearbyResultCallback). devolución de llamada

Busca lugares cerca de una ubicación y una restricción.

Este método no genera bloqueos.

Parámetros:
searchNearbyRequestGMSPlaceSearchNearbyRequest: Es la solicitud de búsqueda cercana que se usará para la consulta.
callbackLa devolución de llamada que se invocará con el resultado de la búsqueda.

- (typedef void(^ GMSPlaceResultCallback)(GMSPlace *_Nullable result, NSError *_Nullable error)) [related]

Tipo de devolución de llamada para recibir búsquedas de detalles de lugares.

Si se produce un error, result será nulo y error contendrá información sobre el error.

Parámetros:
resultadoEl GMSPlace que se mostró.
errorEl error que se produjo, si lo hubo.
- (typedef void(^ GMSPlaceLikelihoodListCallback)(GMSPlaceLikelihoodList *_Nullable likelihoodList, NSError *_Nullable error)) [related]

Tipo de devolución de llamada para recibir listas de probabilidades de lugares.

Si se produce un error, likelihoodList será nulo y error contendrá información sobre el error.

Parámetros:
likelihoodListLa lista de probabilidades de lugares.
errorEl error que se produjo, si lo hubo.
- (typedef void(^ GMSPlaceLikelihoodsCallback)(NSArray< GMSPlaceLikelihood * > *_Nullable probabilidads, NSError *_Nullable error)) [related]

Tipo de devolución de llamada para recibir un array de GMSPlaceLikelihood.

Si se produce un error, el array será nulo y error contendrá información sobre el error.

- (typedef void(^ GMSAutocompletePredictionsCallback)(NSArray< GMSAutocompletePrediction * > *_Nullable results, NSError *_Nullable error)) [related]

Tipo de devolución de llamada para recibir resultados de autocompletado.

results es un array de GMSAutocompletePredictions que representa la finalización de la consulta de los candidatos.

Parámetros:
resultadosUn array de GMSAutocompletePrediction.
errorEl error que se produjo, si lo hubo.
- (typedef void(^ GMSPlacePhotoMetadataResultCallback)(GMSPlacePhotoMetadataList *_Nullable photos, NSError *_Nullable error)) [related]

Tipo de devolución de llamada para recibir resultados de fotos de lugares.

Si se produce un error, photos será nulo y error contendrá información sobre el error.

Parámetros:
fotosEl resultado que contiene objetos GMSPlacePhotoMetadata.
errorEl error que se produjo, si lo hubo.
- (typedef void(^ GMSPlacePhotoImageResultCallback)(UIImage *_Nullable photo, NSError *_Nullable error)) [related]

Tipo de devolución de llamada para recibir objetos UIImage desde un objeto GMSPlacePhotoMetadata.

Si se produce un error, photo será nulo y error contendrá información sobre el error.

Parámetros:
fotoEl UIImage que se cargó.
errorEl error que se produjo, si lo hubo.
- (typedef void(^ GMSPlaceOpenStatusCallback)(resultado GMSPlaceOpenStatus, error NSError *_Nullable error)) [related]

Tipo de devolución de llamada para recibir el estado del horario de atención del lugar.

Si se produjo un error, result será GMSPlaceOpenStatusUnknown y error contendrá información sobre el error.

Parámetros:
resultadoEl GMSPlaceOpenStatus que se mostró.
errorEl error que se produjo, si lo hubo.
- (typedef void(^ GMSPlaceOpenStatusResponseCallback)(GMSPlaceIsOpenResponse *response, NSError *_Nullable error)) [related]

Tipo de devolución de llamada para recibir la respuesta de estado abierto.

Si se produce un error, la respuesta tendrá el estado GMSPlaceOpenStatusUnknown y el error contendrá información sobre él.

Parámetros:
respuestaEl GMSPlaceIsOpenResponse que se mostró.
errorEl error que se produjo, si lo hubo.
- (typedef void(^ GMSPlaceSearchByTextResultCallback)(NSArray< GMSPlace * > *_Nullable places, NSError *_Nullable error)) [related]

Tipo de devolución de llamada para recibir resultados de búsqueda por texto.

results es un array de GMSPlace que representa resultados individuales que coinciden con la consulta.

Parámetros:
resultadosUn array de GMSPlace.
errorEl error que se produjo, si lo hubo.
- (typedef void(^ GMSFetchPhotoResultCallback)(UIImage *_Nullable photoImage, NSError *_Nullable error))) [related]

Tipo de devolución de llamada para recibir una foto.

photoImage es un UIImage que representa la foto resultante que coincide con la solicitud especificada. Si se produce un error, photoImage será nulo y error contendrá información sobre el error.

Parámetros:
photoImageUn resultado UIImage.
- (typedef void(^ GMSAutocompleteSuggestionsCallback)(NSArray< GMSAutocompleteSuggestion * > *_Nullable results, NSError *_Nullable error)) [related]

Tipo de devolución de llamada para resultados de autocompletar.

Parámetros:
resultadosUn array de GMSAutocompleteSuggestion.
errorEl error que se produjo, si lo hubo.
- (typedef void(^ GMSPlaceSearchNearbyResultCallback)(NSArray< GMSPlace * > *_Nullable places, NSError *_Nullable error)) [related]

Tipo de devolución de llamada para recibir resultados de búsqueda cercanos.

Parámetros:
lugaresUn array de GMSPlace
errorEl error que se produjo, si lo hubo.