Documentation de référence sur la classe GMSPlacesClient

Fonctions publiques | Static Public Member Functions | Fonctions associées

Documentation de référence sur la classe GMSPlacesClient

---

Présentation

Interface principale du SDK Places

Permet de rechercher et d'obtenir des informations sur des lieux. Cette classe est accessible via la méthode [GMSPlacesClient sharedClient].

Les méthodes GMSPlacesClient ne doivent être appelées qu'à partir du thread principal. L'appel de ces méthodes à partir d'un autre thread entraîne une exception ou un comportement non défini. Sauf indication contraire, tous les rappels seront appelés sur le thread principal.

Fonctions publiques
(void)	- lookUpPlaceID:callback:
	Obtenez des informations sur un lieu.
(void)	- lookUpPhotosForPlaceID:callback:
	Récupère les métadonnées de 10 photos maximum associées à un lieu.
(void)	- loadPlacePhoto:callback:
	Charge l'image pour une photo spécifique à sa taille maximale.
(void)	- loadPlacePhoto:constrainedToSize:scale:callback:
	Charge l'image d'une photo spécifique, mise à l'échelle pour respecter les dimensions maximales données.
(void)	- currentPlaceWithCallback:
	Renvoie une estimation du lieu où se trouve actuellement l'appareil.
(void)	- findAutocompletePredictionsFromQuery:filter:sessionToken:callback:
	Rechercher des prédictions de saisie semi-automatique à partir d'une requête textuelle
(void)	- fetchPlaceFromPlaceID:placeFields:sessionToken:callback:
	Extraire les détails d'un lieu
(void)	- findPlaceLikelihoodsFromCurrentLocationWithPlaceFields:callback:
	Identifiez les probabilités de lieu à partir de la position actuelle de l'utilisateur.
(void)	- isOpenWithPlaceID:callback:
	Récupère les détails d'un lieu, y compris tous les champs nécessaires pour déterminer GMSPlaceOpenStatus à l'heure actuelle.
(void)	- isOpenWithPlaceID:date:callback:
	Récupère les détails d'un lieu, y compris tous les champs nécessaires pour déterminer GMSPlaceOpenStatus à la NSDate spécifiée.
(void)	- isOpenWithPlace:callback:
	Récupère les détails d'un lieu, y compris tous les champs nécessaires pour déterminer GMSPlaceOpenStatus à l'heure actuelle.
(void)	- isOpenWithPlace:date:callback:
	Récupère les détails d'un lieu, y compris tous les champs nécessaires pour déterminer GMSPlaceOpenStatus à la NSDate spécifiée.
Fonctions publiques de membre statique
(type d'instance)	+ sharedClient
	Fournit l'instance partagée de GMSPlacesClient pour le SDK Google Places pour iOS, qui la crée si nécessaire.
(BOOL)	+ provideAPIKey :
	Fournit votre clé API au SDK Google Places pour iOS.
(NSString *)	+ openSourceLicenseInfo
	Affiche les informations de licence du logiciel Open Source pour le SDK Google Places pour iOS.
(NSString *)	+ SDKVersion
	Renvoie la version du SDK Google Places pour iOS.
(NSString *)	+ SDKLongVersion
	Renvoie la version longue de cette version du SDK Google Places pour iOS.
Fonctions associées
(Notez qu'il ne s'agit pas de fonctions membres.)
Typedef vide(^	GMSPlaceResultCallback )(GMSPlace *_Nullable result, NSError *_Nullable error)
	Type de rappel pour la réception des recherches de détails de lieu.
Typedef vide(^	GMSPlaceLikelihoodListCallback )(GMSPlaceLikelihoodList *_Nullable probabilitéList, NSError *_Nullable error) (en anglais)
	Type de rappel pour la réception de listes de probabilité de lieu.
Typedef vide(^	GMSPlaceLikelihoodsCallback (NSArray< GMSPlaceLikelihood * > *_Nullable probabilités, NSError *_Nullable error)
	Type de rappel pour la réception de tableau de GMSPlaceLikelihood.
Typedef vide(^	GMSAutocompletePredictionsCallback)(NSArray< GMSAutocompletePrediction * > *_Nullable résultats, NSError *_Nullable error)
	Type de rappel pour la réception des résultats de saisie semi-automatique
Typedef vide(^	GMSPlacePhotoMetadataResultCallback )(GMSPlacePhotoMetadataList *_Nullable photos, NSError *_Nullable error)
	Type de rappel pour la réception des résultats des photos de lieux.
Typedef vide(^	GMSPlacePhotoImageResultCallback )(UIImage *_Nullable photo, NSError *_Nullable error)
	Type de rappel pour la réception d'objets UIImage à partir d'un objet GMSPlacePhotoMetadata.
Typedef vide(^	GMSPlaceOpenStatusCallback (résultat GMSPlaceOpenStatus, NSError *_Nullable error)
	Type de rappel pour recevoir l'état des horaires d'ouverture du lieu.

---

Documentation sur la fonction de membre

+ (type d'instance) sharedClient

Fournit l'instance partagée de GMSPlacesClient pour le SDK Google Places pour iOS, qui la crée si nécessaire.

Si votre application utilise souvent des méthodes de GMSPlacesClient, elle peut conserver directement cet objet, sans quoi votre connexion à Google pourra être redémarrée régulièrement.

+ (BOOL) provideAPIKey:

(NSString *)

clé

Fournit votre clé API au SDK Google Places pour iOS.

Cette clé est générée pour votre application via la console Google Cloud Platform et associée à l'ID de bundle de votre application. Il doit être appelé par votre application avant d'utiliser GMSPlacesClient (par exemple, dans application:didFinishLaunchingWithOptions:).

Renvoie :

Oui si la clé API a bien été fournie.

+ (NSString *) openSourceLicenseInfo

Affiche les informations de licence du logiciel Open Source pour le SDK Google Places pour iOS.

Ces informations doivent être disponibles dans votre application.

+ (NSString *) SDKVersion

Renvoie la version du SDK Google Places pour iOS.

(par exemple, "1.0.0").

+ (NSString *) SDKLongVersion

Renvoie la version longue de cette version du SDK Google Places pour iOS.

(par exemple, "1.0.0 (102.1)").

- (void) lookUpPlaceID:		(NSString *)	ID lieu
Rappel:		(GMSPlaceResultCallback).	rappel

Obtenez des informations sur un lieu.

Cette méthode est non bloquante.

Paramètres :

ID du lieu	ID de lieu à rechercher.
rappel	Rappel à appeler avec le résultat de la recherche.

- (void) lookUpPhotosForPlaceID:		(NSString *)	ID lieu
Rappel:		(GMSPlacePhotoMetadataResultCallback).	rappel

Récupère les métadonnées de 10 photos maximum associées à un lieu.

Les photos proviennent de plusieurs sources : des propriétaires d'établissement et des contributions des utilisateurs de Google+. Dans la plupart des cas, ces photos peuvent être utilisées sans attribution, ou contiendront l'attribution obligatoire. Cependant, vous devez utiliser la propriété attributions dans la réponse pour récupérer les mentions supplémentaires requises et les afficher dans votre application où vous affichez l'image. Vous pouvez renvoyer jusqu'à 10 photos.

Plusieurs appels de cette méthode renverront probablement les mêmes photos à chaque fois. Cependant, cela n'est pas garanti, car les données sous-jacentes peuvent avoir changé.

Cette méthode effectue une recherche réseau.

Paramètres :

ID du lieu	ID du lieu pour lequel rechercher des photos.
rappel	Rappel à appeler avec le résultat de la recherche.

- (void) loadPlacePhoto:		(GMSPlacePhotoMetadata *)	photosMetadata
Rappel:		(GMSPlacePhotoImageResultCallback).	rappel

Charge l'image pour une photo spécifique à sa taille maximale.

Les données d'image peuvent être mises en cache par le SDK. Si la photo demandée n'existe pas dans le cache, une recherche réseau est effectuée.

Paramètres :

Métadonnées de photos	GMSPlacePhotoMetadata pour lequel charger un UIImage.
rappel	Rappel à appeler avec le UIImage chargé.

- (void) loadPlacePhoto:		(GMSPlacePhotoMetadata *)	photosMetadata
constrainedToSize:		(taille de la vitre avant)	maxSize
Échelle:		(CGFloat)	à grande échelle
Rappel:		(GMSPlacePhotoImageResultCallback).	rappel

Charge l'image d'une photo spécifique, mise à l'échelle pour respecter les dimensions maximales données.

L'image est mise à l'échelle afin de s'adapter aux dimensions données, tout en conservant les proportions de l'image d'origine. Ce scaling s'effectue côté serveur.

Si le paramètre d'échelle n'est pas 1.0, la taille maximale sera multipliée par cette valeur et le UIImage renvoyé sera défini pour avoir l'échelle spécifiée. Ce paramètre doit être défini sur l'échelle de l'écran si vous chargez des images pour les afficher à l'écran.

Les données d'image peuvent être mises en cache par le SDK. Si la photo demandée n'existe pas dans le cache, une recherche réseau est effectuée.

Remarque :

Une fois le facteur de scaling appliqué, les dimensions de maxSize sont arrondies à l'entier le plus proche avant utilisation. Si une image plus grande que la taille maximale disponible est demandée, elle peut être renvoyée.

Paramètres :

Métadonnées de photos	GMSPlacePhotoMetadata pour lequel charger un UIImage.
Taille max.	Taille maximale de l'image.
Google.	Échelle permettant de charger l'image.
rappel	Rappel à appeler avec le UIImage chargé.

- (void) currentPlaceWithCallback:

(GMSPlaceLikelihoodListCallback).

callback

Renvoie une estimation du lieu où se trouve actuellement l'appareil.

Génère une liste de probabilité de lieu en fonction de la dernière position estimée de l'appareil. Le rappel fourni sera appelé avec cette liste de probabilités en cas de réussite et une erreur "NSError" en cas d'erreur.

Remarque :

Cette méthode nécessite que votre application soit autorisée à accéder à la position actuelle de l'appareil. Avant d'appeler cette méthode, assurez-vous de demander l'accès à la position des utilisateurs à l'aide de [CLLocationManager requestwhenInUseUsage] ou [CLLocationManager requestAlwaysPermission]. Si vous appelez cette méthode et que l'état d'autorisation de votre application n'est pas correct, le rappel sera appelé avec une erreur.

Paramètres :

rappel

Rappel à appeler avec la liste de probabilité de lieu.

- (void) findAutocompletePredictionsFromQuery:		(NSString *)	query
filtre :		(null, GMSAutocompleteFilter *)	filtre
sessionToken:		(null, GMSAutocompleteSessionToken *)	sessionToken (jeton de session)
Rappel:		(GMSAutocompletePredictionsCallback).	rappel

Rechercher des prédictions de saisie semi-automatique à partir d'une requête textuelle

Les résultats peuvent éventuellement être orientés vers un certain lieu ou limités à une zone. Cette méthode est non bloquante.

Le rappel fourni est appelé avec un tableau de prédictions de saisie semi-automatique en cas de réussite et une erreur NSError en cas d'erreur.

Paramètres :

requête	Texte partiel à utiliser pour la saisie semi-automatique.
filtre	Filtre à appliquer aux résultats. Ce paramètre peut être nul.
jeton de session	GMSAutocompleteSessionToken pour associer la requête à une session de facturation.
rappel	Rappel à appeler avec les prédictions.

- (void) fetchPlaceFromPlaceID:		(NSString *)	ID lieu
placeFields:		(GMSPlaceField).	placesChamps
sessionToken:		(null, GMSAutocompleteSessionToken *)	sessionToken (jeton de session)
Rappel:		(GMSPlaceResultCallback).	rappel

Extraire les détails d'un lieu

Cette méthode est non bloquante.

Paramètres :

ID du lieu	ID de lieu à rechercher.
placeFields	Champs de lieu individuels demandés pour les objets de lieu dans la liste.
jeton de session	GMSAutocompleteSessionToken pour associer la requête à une session de facturation.
rappel	Rappel à appeler avec le résultat de la recherche.

- (void) findPlaceLikelihoodsFromCurrentLocationWithPlaceFields:		(GMSPlaceField).	placesChamps
Rappel:		(GMSPlaceLikelihoodsCallback).	rappel

Identifiez les probabilités de lieu à partir de la position actuelle de l'utilisateur.

Cette méthode est non bloquante.

Le rappel fourni sera appelé avec un tableau de lieux avec des scores de probabilité en cas de réussite et une NSError en cas d'erreur.

Paramètres :

placeFields	Champs de lieu individuels demandés pour les objets de lieu dans la liste.
rappel	Rappel à appeler avec des probabilités de lieu.

- (void) isOpenWithPlaceID:		(NSString *)	ID lieu
Rappel:		(GMSPlaceOpenStatusCallback).	rappel

Récupère les détails d'un lieu, y compris tous les champs nécessaires pour déterminer GMSPlaceOpenStatus à l'heure actuelle.

Cette méthode est non bloquante.

Paramètres :

ID du lieu	ID de lieu à rechercher.
rappel	Rappel à appeler avec le résultat du lieu.

- (void) isOpenWithPlaceID:		(NSString *)	ID lieu
Date :		(NSDate *)	date
Rappel:		(GMSPlaceOpenStatusCallback).	rappel

Récupère les détails d'un lieu, y compris tous les champs nécessaires pour déterminer GMSPlaceOpenStatus à la NSDate spécifiée.

Cette méthode est non bloquante.

Paramètres :

ID du lieu	ID de lieu à rechercher.
date	NSDate pour déterminer l'état d'ouverture.
rappel	Rappel à appeler avec le résultat du lieu.

- (void) isOpenWithPlace:		(GMSPlace *)	lieu
Rappel:		(GMSPlaceOpenStatusCallback).	rappel

Récupère les détails d'un lieu, y compris tous les champs nécessaires pour déterminer GMSPlaceOpenStatus à l'heure actuelle.

Ne demande des champs supplémentaires que si GMSPlace ne contient pas tous les champs nécessaires. Sinon, GMSPlaceOpenStatus est immédiatement renvoyé dans le rappel. Cette méthode est non bloquante.

Paramètres :

lieu	GMSPlace à rechercher.
rappel	Rappel à appeler avec le résultat du lieu.

- (void) isOpenWithPlace:		(GMSPlace *)	lieu
Date :		(NSDate *)	date
Rappel:		(GMSPlaceOpenStatusCallback).	rappel

Récupère les détails d'un lieu, y compris tous les champs nécessaires pour déterminer GMSPlaceOpenStatus à la NSDate spécifiée.

Ne demande des champs supplémentaires que si le GMSPlace ne contient pas tous les champs nécessaires, sinon GMSPlaceOpenStatus\ will be returned in the callback immediately. This method is non-blocking.

Parameters:

place	The GMSPlace to lookup.
date	The NSDate to determine open status for.
callback	The callback to invoke with the place result.

---

Documentation sur les amis et les fonctions associées

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

Type de rappel pour la réception des recherches de détails de lieu.

Si une erreur s'est produite, result est nul, et error contient des informations sur l'erreur.

Paramètres :

résultat	GMSPlace renvoyé.
erreur	L'erreur qui s'est produite, le cas échéant.

- (typedef void(^ GMSPlaceLikelihoodListCallback)(GMSPlaceLikelihoodList *_Nullable probabilitéList, NSError *_Nullable error)) [related]

Type de rappel pour la réception de listes de probabilité de lieu.

Si une erreur s'est produite, likelihoodList est nul, et error contient des informations sur l'erreur.

Paramètres :

liste de probabilité	Liste des probabilités de lieu.
erreur	L'erreur qui s'est produite, le cas échéant.

- (typedef void(^ GMSPlaceLikelihoodsCallback)(NSArray< GMSPlaceLikelihood * > *_Nullable probabilités, NSError *_Nullable error)) [related]

Type de rappel pour la réception de tableau de GMSPlaceLikelihood.

Si une erreur s'est produite, le tableau sera nul, et error contiendra des informations sur l'erreur.

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

Type de rappel pour la réception des résultats de saisie semi-automatique

results est un tableau de GMSAutocompletePredictions représentant les achèvements potentiels de la requête.

Paramètres :

résultats	Tableau de valeurs GMSAutocompletePrediction.
erreur	L'erreur qui s'est produite, le cas échéant.

- (typedef void(^ GMSPlacePhotoMetadataResultCallback)(GMSPlacePhotoMetadataList *_Nullable photos, NSError *_Nullable error)) [related]

Type de rappel pour la réception des résultats des photos de lieux.

Si une erreur s'est produite, photos est nul, et error contient des informations sur l'erreur.

Paramètres :

photos	Résultat contenant des objets GMSPlacePhotoMetadata.
erreur	L'erreur qui s'est produite, le cas échéant.

- (typedef void(^ GMSPlacePhotoImageResultCallback)(UIImage *_Nullable photo, NSError *_Nullable error)) [related]

Type de rappel pour la réception d'objets UIImage à partir d'un objet GMSPlacePhotoMetadata.

Si une erreur s'est produite, photo est nul, et error contient des informations sur l'erreur.

Paramètres :

photo	UIImage chargé.
erreur	L'erreur qui s'est produite, le cas échéant.

- (typedef void(^ GMSPlaceOpenStatusCallback)(résultat GMSPlaceOpenStatus, NSError *_Nullable error)) [related]

Type de rappel pour recevoir l'état des horaires d'ouverture du lieu.

Si une erreur s'est produite, result sera GMSPlaceOpenStatusUnknown et error contiendra des informations sur l'erreur.

Paramètres :

résultat	GMSPlaceOpenStatus renvoyé.
erreur	L'erreur qui s'est produite, le cas échéant.