Referencia de la clase GMSPlacesClient


Descripción general

Interfaz principal del SDK de Places.

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

Los métodos GMSPlacesClient solo se deben llamar 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 públicas de miembro

(void) - lookUpPlaceID:callback:
 Obtén detalles sobre un lugar.
(void) - lookUpPhotosForPlaceID:callback:
 Obtiene los metadatos de hasta 10 fotos asociadas con un lugar.
(void) - loadPlacePhoto:callback:
 Carga la imagen de una foto específica en su tamaño máximo.
(void) - loadPlacePhoto:constrainedToSize:scale:callback:
 Carga la imagen de una foto específica, ajustada a escala para que se ajuste a las dimensiones máximas especificadas.
(void) - currentPlaceWithCallback:
 Muestra una estimación de la ubicación actual del dispositivo.
(void) - findAutocompletePredictionsFromQuery:filter:sessionToken:callback:
 Busca predicciones de Autocomplete a partir de una consulta de texto.
(void) - fetchPlaceFromPlaceID:placeFields:sessionToken:callback:
 Obtener detalles para un lugar.
(void) - findPlaceLikelihoodsFromCurrentLocationWithPlaceFields:callback:
 Encontrar las probabilidades de lugar usando la ubicación actual del usuario.
(void) - isOpenWithPlaceID:callback:
 Obtiene detalles de un lugar, incluidos todos los campos necesarios para determinar GMSPlaceOpenStatus en la hora actual.
(void) - isOpenWithPlaceID:date:callback:
 Obtiene los detalles de un lugar, incluidos todos los campos necesarios para determinar GMSPlaceOpenStatus en el NSDate especificado.
(void) - isOpenWithPlace:callback:
 Obtiene detalles de un lugar, incluidos todos los campos necesarios para determinar GMSPlaceOpenStatus en la hora actual.
(void) - isOpenWithPlace:date:callback:
 Obtiene los detalles de un lugar, incluidos todos los campos necesarios para determinar GMSPlaceOpenStatus en el NSDate especificado.

Funciones de miembro públicas estáticas

(tipo de instancia)+ sharedClient.
 Proporciona la instancia compartida de GMSPlacesClient para el SDK de Google Places para iOS, y la crea si es necesario.
(BOOL) + provideAPIKey:
 Proporciona tu clave de API al SDK de Google Places para iOS.
(NSString *)Más openSourceLicenseInfo
 Muestra la información de la licencia de software de código abierto del 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 *_Nullable result, NSError *_Nullable error)
 Tipo de devolución de llamada para recibir búsquedas de detalles de lugares.
typedef void(^ GMSPlaceLikelihoodListCallback )(GMSPlaceLikelihoodList *_Nullable probabilidadeslihoodList, NSError *_Nullable error)
 Tipo de devolución de llamada para recibir listas de probabilidades de lugares.
typedef void(^ GMSPlaceLikelihoodsCallback )(NSArray< GMSPlaceLikelihood * > *_Nullable probabilidades, 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 de un objeto GMSPlacePhotoMetadata.
typedef void(^ GMSPlaceOpenStatusCallback )(resultado GMSPlaceOpenStatus, NSError *_Nullable error)
 Tipo de devolución de llamada para recibir el estado del horario de atención de Place.

Documentación de las funciones de los miembros

+ (tipo de instancia) sharedClient

Proporciona la instancia compartida de GMSPlacesClient para el SDK de Google Places para iOS, y la crea si es necesario.

Si tu aplicación suele usar métodos de GMSPlacesClient, es posible que te convenga conservar este objeto directamente, ya que, de lo contrario, tu conexión con Google podría reiniciarse periódicamente.

+ (BOOL) provideAPIKey: (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 Google Cloud Platform Console 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., in application:didFinishLaunchingWithOptions:).

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

Muestra la información de la licencia de software de código abierto del 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.

. Por ejemplo, “1.0.0”.

+ (NSString *) SDKLongVersion

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

. Por ejemplo, "1.0.0 (102.1)".

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

Obtén detalles sobre un lugar.

Este método no genera bloqueos.

Parámetros:
placeIDEs el ID del lugar que se debe buscar.
callbackEs la devolución de llamada que se invocará con el resultado de la búsqueda.
- (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 una variedad de ubicaciones, como los propietarios de empresas y las fotos aportadas por usuarios de Google+. En la mayoría de los casos, estas fotos se pueden utilizar sin atribución, o bien 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 necesarias y mostrarlas en tu aplicación en cualquier lugar en el que muestres la imagen. Se mostrarán un máximo de 10 fotos.

Es probable que las llamadas múltiples de este método muestren las mismas fotos cada vez. Sin embargo, esto no está garantizado porque los datos subyacentes pueden haber cambiado.

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

Parámetros:
placeIDEl ID de lugar con el que se buscarán fotos.
callbackEs la 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 datos de imágenes en caché. Si la foto solicitada no existe en la memoria caché, se realizará una búsqueda de red.

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

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

Las imágenes se ajustarán para ajustarse a las dimensiones dadas y, al mismo tiempo, se mantendrá 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, se multiplicará el tamaño máximo de maxSize por este valor y se establecerá el valor UIImage que se muestra para la escala especificada. Este parámetro se debe establecer en la escala de pantalla si cargas imágenes para mostrar en la pantalla.

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

Nota:
Después de aplicar el factor de escala, se redondearán las dimensiones en maxSize al número entero más cercano antes de usarlas. Si se solicita una imagen que es más grande que 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.
maxSizeEs el tamaño máximo de la imagen.
de Google.La escala en la que se cargará la imagen.
callbackEs la devolución de llamada que se invocará con el UIImage cargado.

Muestra una estimación de la ubicación actual del dispositivo.

Genera una lista de probabilidades de lugar según la última ubicación estimada del dispositivo. La devolución de llamada proporcionada se invocará con esta lista de probabilidades si la operación es exitosa y un NSError cuando se produzca 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 esta función, 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 llamará a la devolución de llamada con un error.
Parámetros:
callbackEs la devolución de llamada que se invocará con la lista de probabilidades de sitios.
- (void) findAutocompletePredictionsFromQuery: (NSString *) query
filtro: (GMSAutocompleteFilter anulable *) filtro
sessionToken: (GMSAutocompleteSessionToken * anulable) sessionToken
devolución de llamada: (GMSAutocompletePredictionsCallback). devolución de llamada

Busca predicciones de Autocomplete a partir de una consulta de texto.

Los resultados pueden personalizarse opcionalmente para una ubicación determinada o restringirse a un área. Este método no genera bloqueos.

La devolución de llamada proporcionada se invocará con un conjunto de predicciones de autocompletado si la operación es exitosa y un NSError cuando se produzca un error.

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

Obtener detalles para un lugar.

Este método no genera bloqueos.

Parámetros:
placeIDEs el ID del lugar que se debe buscar.
placeFieldsLos 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.
callbackEs la devolución de llamada que se invocará con el resultado de la búsqueda.
- (void) findPlaceLikelihoodsFromCurrentLocationWithPlaceFields: (GMSPlaceField). placeFields
devolución de llamada: (GMSPlaceLikelihoodsCallback). devolución de llamada

Encontrar las probabilidades de lugar usando la ubicación actual del usuario.

Este método no genera bloqueos.

La devolución de llamada proporcionada se invocará con un array de sitios con puntuaciones de probabilidad cuando se realiza correctamente y con un NSError cuando se produce un error.

Parámetros:
placeFieldsLos campos de lugar individuales solicitados para los objetos de lugar de la lista.
callbackEs la devolución de llamada que se invocará con las probabilidades de lugar.
- (void) isOpenWithPlaceID: (NSString *) placeID
devolución de llamada: (GMSPlaceOpenStatusCallback). devolución de llamada

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

Este método no genera bloqueos.

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

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

Este método no genera bloqueos.

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

Obtiene detalles 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 de inmediato en la devolución de llamada. 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 de lugar.
- (void) isOpenWithPlace: (GMSPlace *) lugar
Fecha: (NSDate *) date
devolución de llamada: (GMSPlaceOpenStatusCallback). devolución de llamada

Obtiene los 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.


- (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 tendrá el valor "nil" y error contendrá información sobre el error.

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

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

Si se produce un error, likelihoodList tendrá el valor "nil" y error contendrá información sobre el error.

Parámetros:
likelihoodListEs la lista de probabilidades de lugar.
errorEl error que se produjo, si corresponde.
- (typedef void(^ GMSPlaceLikelihoodsCallback)(NSArray< GMSPlaceLikelihood * > *_Nullable probabilidades, NSError *_Error nulable)) [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 por parte de los candidatos.

Parámetros:
resultadosUn array de GMSAutocompletePrediction.
errorEl error que se produjo, si corresponde.
- (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 tendrá el valor "nil" y error contendrá información sobre el error.

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

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

Si se produce un error, photo tendrá el valor "nil" y error contendrá información sobre el error.

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

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

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

Parámetros:
resultadoEl GMSPlaceOpenStatus que se mostró.
errorEl error que se produjo, si corresponde.