Documentation de référence sur la classe GMSPlacesClient

Documentation de référence sur la classe GMSPlacesClient

Présentation

Interface principale du SDK Places.

Utilisé pour rechercher et obtenir des informations sur des lieux. Vous devez accéder à cette classe 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înera une exception ou un comportement non défini. Sauf indication contraire, tous les rappels seront appelés sur le thread principal.

Fonctions de membre public

(void) - lookUpPlaceID:callback:
 Obtenez des informations sur un lieu.
(void) - lookUpPhotosForPlaceID:callback:
 Récupère les métadonnées de 10 photos associées à un lieu au maximum.
(void) loadPlacePhoto:callback:
 Charge l'image d'une photo spécifique en taille maximale.
(void) - loadPlacePhoto:constrainedToSize:scale:callback:
 Charge l'image d'une photo spécifique, mise à l'échelle pour l'adapter aux dimensions maximales données.
(void) - currentPlaceWithCallback:
 Affiche 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:
 Extrayez les informations d'un lieu.
(void) - findPlaceLikelihoodsFromCurrentLocationWithPlaceFields:callback:
 Trouvez des probabilités de lieu à l'aide 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 au NSDate spécifié.
(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 au NSDate spécifié.

Fonctions de membre public statique

(type d'instance)+ sharedClient
 Fournit l'instance partagée de GMSPlacesClient pour le SDK Google Places pour iOS, en la créant si nécessaire.
(BOOL) + provideAPIKey :
 Fournit votre clé API au SDK Google Places pour iOS.
(NSString *)+ openSourceLicenseInfo
 Renvoie les informations sur la licence du logiciel Open Source pour le SDK Google Places pour iOS.
(NSString *)+ SDKVersion
 Renvoie la version correspondant à cette version du SDK Google Places pour iOS.
(NSString *)+ SDKLongVersion
 Renvoie la version longue de cette version du SDK Google Places pour iOS.

(Notez qu'il ne s'agit pas de fonctions membres.)

typedef void(^ GMSPlaceResultCallback)(GMSPlace *_Nullable résultat, NSError *_Nullable erreur)
 Type de rappel pour la réception des recherches de détails sur un lieu.
typedef void(^ GMSPlaceLikelihoodListCallback )(GMSPlaceLikelihoodList *_NullableABILITYList, NSError *_Nullable erreur)
 Type de rappel pour la réception de listes de probabilité de lieu.
typedef void(^ GMSPlaceLikelihoodsCallback )(NSArray< GMSPlaceLikelihood * > *_Nullable probabilités, NSError *_Nullable erreur)
 Type de rappel pour la réception d'un tableau de GMSPlaceLikelihood
typedef void(^ GMSAutocompletePredictionsCallback )(NSArray< GMSAutocompletePrediction * > *_Nullable résultats, NSError *_Nullable erreur)
 Type de rappel pour la réception des résultats de saisie semi-automatique.
typedef void(^ GMSPlacePhotoMetadataResultCallback)(GMSPlacePhotoMetadataList *_Nullable photos, NSError *_Nullable erreur)
 Type de rappel pour la réception des résultats concernant les photos de lieux.
typedef void(^ GMSPlacePhotoImageResultCallback )(UIImage *_Nullable photo, NSError *_Nullable erreur)
 Type de rappel pour la réception d'objets UIImage à partir d'un objet GMSPlacePhotoMetadata.
typedef void(^ GMSPlaceOpenStatusCallback)(résultat GMSPlaceOpenStatus, erreur NSError *_Nullable)
 Type de rappel pour recevoir les horaires d'ouverture de l'établissement.

Documentation sur la fonction de membre

+ (type d'instance) sharedClient

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

Si votre application utilise souvent des méthodes GMSPlacesClient, il peut être judicieux de conserver directement cet objet, sinon votre connexion à Google pourrait redémarrer 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. Elle est associée à l'ID de bundle de votre application afin de l'identifier. Cette méthode doit être appelée par votre application avant d'utiliser GMSPlacesClient (par exemple, dans application:didFinishLaunchingWithOptions:).

Renvoie :
OUI si la clé API a bien été fournie.
+ (NSString *) openSourceLicenseInfo

Renvoie les informations sur la licence du logiciel Open Source pour le SDK Google Places pour iOS.

Ces informations doivent être disponibles dans votre demande.

+ (NSString *) SDKVersion

Renvoie la version correspondant à cette version du SDK Google Places pour iOS.

. 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 *) placeID
: (GMSPlaceResultCallback). rappel

Obtenez des informations sur un lieu.

Cette méthode est non bloquante.

Paramètres :
placeIDID de lieu à rechercher.
rappelRappel à invoquer avec le résultat de la recherche.
- (void) lookUpPhotosForPlaceID: (NSString *) placeID
: (GMSPlacePhotoMetadataResultCallback). rappel

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

Les photos proviennent de plusieurs sources, y compris celles des propriétaires d'établissement et des photos fournies par les utilisateurs de Google+. Dans la plupart des cas, ces photos peuvent être utilisées sans attribution, ou présenteront l'attribution requise dans l'image. Toutefois, vous devez utiliser la propriété attributions dans la réponse pour récupérer les attributions supplémentaires requises et afficher ces attributions dans votre application partout où vous affichez l'image. Jusqu'à 10 photos sont renvoyées.

Si vous appelez cette méthode plusieurs fois, les mêmes photos seront probablement renvoyées à chaque fois. Toutefois, cela n'est pas garanti, car les données sous-jacentes peuvent avoir changé.

Cette méthode effectue une recherche réseau.

Paramètres :
placeIDID de lieu pour lequel rechercher des photos.
rappelRappel à invoquer avec le résultat de la recherche.
- (void) loadPlacePhoto: (GMSPlacePhotoMetadata *) photoMetadata
: (GMSPlacePhotoImageResultCallback). rappel

Charge l'image d'une photo spécifique en 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 sur le réseau est effectuée.

Paramètres :
photoMetadataGMSPlacePhotoMetadata pour lequel charger un élément UIImage.
rappelRappel à invoquer avec le UIImage chargé.
- (void) loadPlacePhoto: (GMSPlacePhotoMetadata *) photoMetadata
constrainedToSize: (taille de la vitre avant) maxSize
Échelle: (CGFloat) à grande échelle
: (GMSPlacePhotoImageResultCallback). rappel

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

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

Si le paramètre "scale" n'est pas 1.0, la valeur "maxSize" est multipliée par cette valeur, et la valeur UIImage renvoyée est définie sur l'échelle spécifiée. Ce paramètre doit être défini sur l'échelle d'écran si vous chargez des images à 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 sur le réseau est effectuée.

Remarque :
Une fois le facteur d'échelle appliqué, les dimensions de "maxSize" sont arrondies à l'entier le plus proche avant utilisation. Si une image dont la taille est supérieure à la taille maximale disponible est demandée, une image plus petite peut être renvoyée.
Paramètres :
photoMetadataGMSPlacePhotoMetadata pour lequel charger un élément UIImage.
maxSizeTaille maximale de l'image.
Google.Échelle à laquelle charger l'image.
rappelRappel à invoquer avec le UIImage chargé.

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

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

Remarque :
Pour utiliser cette méthode, votre application doit être autorisée à accéder à la position actuelle de l'appareil. Avant d'appeler cette méthode, veillez à demander l'accès à la position des utilisateurs à l'aide de [CLLocationManager requestWhenInUseAuthorization] ou [CLLocationManager requestAlwaysAuthorization]. Si vous appelez cette méthode et que l'état d'autorisation de votre application n'est pas correct, le rappel sera appelé et généré une erreur.
Paramètres :
rappelRappel à invoquer avec la liste de probabilité de lieu.
- (void) findAutocompletePredictionsFromQuery: (NSString *) query
filtre : (possibilité de valeur nulle pour GMSAutocompleteFilter *) filtre
sessionToken: (peut être nul : GMSAutocompleteSessionToken *) sessionToken
: (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 lieu donné ou limités à une zone spécifique. Cette méthode est non bloquante.

Le rappel fourni sera 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êteTexte partiel à saisie semi-automatique.
filtreFiltre à appliquer aux résultats. Ce paramètre peut avoir la valeur "nil".
sessionTokenGMSAutocompleteSessionToken pour associer la requête à une session de facturation.
rappelRappel à invoquer avec les prédictions.
- (void) fetchPlaceFromPlaceID: (NSString *) placeID
placeFields: (GMSPlaceField). placeFields
sessionToken: (peut être nul : GMSAutocompleteSessionToken *) sessionToken
: (GMSPlaceResultCallback). rappel

Extrayez les informations d'un lieu.

Cette méthode est non bloquante.

Paramètres :
placeIDID de lieu à rechercher.
placeFieldsChamps de lieu individuels demandés pour les objets Place de la liste.
sessionTokenGMSAutocompleteSessionToken pour associer la requête à une session de facturation.
rappelRappel à invoquer avec le résultat de la recherche.
- (void) findPlaceLikelihoodsFromCurrentLocationWithPlaceFields: (GMSPlaceField). placeFields
: (GMSPlaceLikelihoodsCallback). rappel

Trouvez des probabilités de lieu à l'aide 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 erreur NSError en cas d'erreur.

Paramètres :
placeFieldsChamps de lieu individuels demandés pour les objets Place de la liste.
rappelRappel à invoquer avec les probabilités de lieu.
- (void) isOpenWithPlaceID: (NSString *) placeID
: (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 :
placeIDID de lieu à rechercher.
rappelRappel à invoquer avec le résultat du lieu.
- (void) isOpenWithPlaceID: (NSString *) placeID
Date : (NSDate *) date
: (GMSPlaceOpenStatusCallback). rappel

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

Cette méthode est non bloquante.

Paramètres :
placeIDID de lieu à rechercher.
dateNSDate pour lequel déterminer l'état d'ouverture.
rappelRappel à invoquer avec le résultat du lieu.
- (void) isOpenWithPlace: (GMSPlace *) lieu
: (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 comporte pas tous les champs nécessaires. Sinon, GMSPlaceOpenStatus est immédiatement renvoyé dans le rappel. Cette méthode est non bloquante.

Paramètres :
lieuGMSPlace à rechercher.
rappelRappel à invoquer avec le résultat du lieu.
- (void) isOpenWithPlace: (GMSPlace *) lieu
Date : (NSDate *) date
: (GMSPlaceOpenStatusCallback). rappel

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

Ne demande des champs supplémentaires que si GMSPlace ne comporte pas tous les champs nécessaires, sinon 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 résultat, NSError *_Nullable error)) [related]

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

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

Paramètres :
résultatGMSPlace renvoyé.
errorErreur qui s'est produite, le cas échéant.
- (typedef void(^ GMSPlaceLikelihoodListCallback)(GMSPlaceLikelihoodList *_Nullable encryptionList, NSError *_Nullable error)) [related]

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

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

Paramètres :
likelihoodListListe des probabilités de lieu.
errorErreur 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 d'un 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 suggestions d'achèvement de la requête.

Paramètres :
résultatsTableau de valeurs GMSAutocompletePrediction.
errorErreur 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 concernant les photos de lieux.

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

Paramètres :
photosRésultat contenant des objets GMSPlacePhotoMetadata.
errorErreur 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 sera nul et error contiendra des informations sur l'erreur.

Paramètres :
photoUIImage chargé.
errorErreur qui s'est produite, le cas échéant.
- (typedef void(^ GMSPlaceOpenStatusCallback)(résultat GMSPlaceOpenStatus, NSError *_Nullable error)) [related]

Type de rappel pour recevoir les horaires d'ouverture de l'établissement.

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

Paramètres :
résultatGMSPlaceOpenStatus renvoyé.
errorErreur qui s'est produite, le cas échéant.