GMSPlacesClient-Klassenreferenz


Überblick

Hauptschnittstelle des Places SDK

Wird zum Suchen und Abrufen von Details zu Orten verwendet. Der Zugriff auf diese Klasse sollte über die [GMSPlacesClient sharedClient]-Methode erfolgen.

GMSPlacesClient-Methoden sollten nur vom Hauptthread aus aufgerufen werden. Das Aufrufen dieser Methoden aus einem anderen Thread führt zu einer Ausnahme oder einem nicht definierten Verhalten. Sofern nicht anders angegeben, werden alle Callbacks im Hauptthread aufgerufen.

Öffentliche Mitgliederfunktionen

(void) lookUpPlaceID:callback:
 Details zu einem Ort abrufen
(void) lookUpPhotosForPlaceID:callback:
 Ruft die Metadaten für bis zu zehn Fotos ab, die einem Ort zugeordnet sind.
(void) loadPlacePhoto:callback:
 Lädt das Bild für ein bestimmtes Foto in seiner maximalen Größe.
(void) loadPlacePhoto:constrainedToSize:scale:callback:
 Lädt das Bild für ein bestimmtes Foto, skaliert auf die vorgegebenen maximalen Abmessungen.
(void) currentPlaceWithCallback:
 Gibt eine Schätzung des Ortes zurück, an dem sich das Gerät derzeit befindet.
(void) findAutocompletePredictionsFromQuery:filter:sessionToken:callback:
 Automatische Vervollständigung über eine Textabfrage finden.
(void) fetchPlaceFromPlaceID:placeFields:sessionToken:callback:
 Details zu einem Ort abrufen
(void) findPlaceLikelihoodsFromCurrentLocationWithPlaceFields:callback:
 Wahrscheinlichkeiten von Orten anhand des aktuellen Standorts des Nutzers ermitteln
(void) isOpenWithPlaceID:callback:
 Ruft Details zu einem Ort ab, einschließlich aller erforderlichen Felder, um GMSPlaceOpenStatus zum aktuellen Zeitpunkt zu bestimmen.
(void) isOpenWithPlaceID:date:callback:
 Ruft Details zu einem Ort ab, einschließlich aller erforderlichen Felder, um das GMSPlaceOpenStatus-Element an der angegebenen NSDate zu bestimmen.
(void) isOpenWithPlace:callback:
 Ruft Details zu einem Ort ab, einschließlich aller erforderlichen Felder, um GMSPlaceOpenStatus zum aktuellen Zeitpunkt zu bestimmen.
(void) isOpenWithPlace:date:callback:
 Ruft Details zu einem Ort ab, einschließlich aller erforderlichen Felder, um das GMSPlaceOpenStatus-Element an der angegebenen NSDate zu bestimmen.

Statische Funktionen für öffentliche Mitglieder

(Instanztyp)+ sharedClient
 Stellt die gemeinsam genutzte Instanz von GMSPlacesClient für das Google Places SDK for iOS bereit und erstellt sie bei Bedarf.
(BOOL) + provideAPIKey:
 Stellt Ihren API-Schlüssel für das Google Places SDK for iOS bereit.
(NSString *)+ openSourceLicenseInfo
 Gibt die Open-Source-Softwarelizenzinformationen für das Google Places SDK for iOS zurück.
(NSString *)+ SDKVersion
 Gibt die Version für diese Version des Google Places SDK for iOS zurück.
(NSString *)+ SDKLongVersion
 Gibt die lange Version für diese Version des Google Places SDK for iOS zurück.

(Beachten Sie, dass dies keine Mitgliederfunktionen sind.)

typedef void(^ GMSPlaceResultCallback )(GMSPlace *_Nullable-Ergebnis, NSError *_Nullable-Fehler)
 Callback-Typ für den Empfang von Lookups für Ortsdetails.
typedef void(^ GMSPlaceLikelihoodListCallback)(GMSPlaceLikelihoodList *_Nullable LikeList, NSError *_Nullable error)
 Callback-Typ für den Empfang von Ortswahrscheinlichkeitslisten.
typedef void(^ GMSPlaceLikelihoodsCallback )(NSArray< GMSPlaceLikelihood * > *_Nullable Likelihoods, NSError *_Nullable error)
 Callback-Typ für den Empfang eines Arrays mit GMSPlaceLikelihood-Werten.
typedef void(^ GMSAutocompletePredictionsCallback )(NSArray< GMSAutocompletePrediction * > *_Nullable-Ergebnisse, NSError *_Nullable-Fehler)
 Callback-Typ für den Empfang von Ergebnissen der automatischen Vervollständigung.
typedef void(^ GMSPlacePhotoMetadataResultCallback )(GMSPlacePhotoMetadataList *_Nullable-Fotos, NSError *_Nullable-Fehler)
 Callback-Typ für den Empfang von Ergebnissen für Ortsfotos.
typedef void(^ GMSPlacePhotoImageResultCallback)(UIImage *_Nullable-Foto, NSError *_Nullable-Fehler)
 Callback-Typ für den Empfang von UIImage-Objekten von einem GMSPlacePhotoMetadata-Objekt.
typedef void(^ GMSPlaceOpenStatusCallback (GMSPlaceOpenStatus-Ergebnis, NSError *_Nullable-Fehler)
 Callback-Typ, mit dem der Status der Öffnungszeiten des Orts abgerufen wird

Dokumentation zu Mitgliederfunktionen

+ (Instanztyp) sharedClient

Stellt die gemeinsam genutzte Instanz von GMSPlacesClient für das Google Places SDK for iOS bereit und erstellt sie bei Bedarf.

Wenn Ihre Anwendung häufig Methoden von GMSPlacesClient verwendet, kann sie direkt an diesem Objekt festhalten, da die Verbindung zu Google sonst möglicherweise regelmäßig neu gestartet wird.

+ (BOOL) provideAPIKey: (NSString *) key

Stellt Ihren API-Schlüssel für das Google Places SDK for iOS bereit.

Dieser Schlüssel wird über die Google Cloud Platform Console für Ihre Anwendung generiert und mit der Bundle-ID Ihrer Anwendung gekoppelt, um sie zu identifizieren. Dieses sollte von Ihrer Anwendung vor der Verwendung von GMSPlacesClient aufgerufen werden (z.B. in application:didFinishLaunchingWithOptions:).

Gibt zurück:
JA, wenn der API-Schlüssel erfolgreich angegeben wurde.
+ (NSString *) openSourceLicenseInfo

Gibt die Open-Source-Softwarelizenzinformationen für das Google Places SDK for iOS zurück.

Diese Informationen müssen in Ihrem Antrag zur Verfügung gestellt werden.

+ (NSString *) SDKVersion

Gibt die Version für diese Version des Google Places SDK for iOS zurück.

. Beispiel: „1.0.0“.

+ (NSString *) SDKLongVersion

Gibt die lange Version für diese Version des Google Places SDK for iOS zurück.

Beispiel: „1.0.0 (102.1)“.

- (void) lookUpPlaceID: (NSString *) placeID
Callback: (GMSPlaceResultCallback) Callback

Details zu einem Ort abrufen

Diese Methode blockiert nicht.

Parameter:
placeIDDie Orts-ID, nach der gesucht werden soll.
callbackDer Callback, der mit dem Suchergebnis aufgerufen werden soll.
- (void) lookUpPhotosForPlaceID: (NSString *) placeID
Callback: (GMSPlacePhotoMetadataResultCallback) Callback

Ruft die Metadaten für bis zu zehn Fotos ab, die einem Ort zugeordnet sind.

Die Fotos stammen aus verschiedenen Quellen, z. B. von Geschäftsinhabern oder von Google+ Nutzern. In den meisten Fällen können diese Fotos ohne Quellenangabe verwendet werden oder sind im Bild enthalten. Sie müssen jedoch das Attribut attributions in der Antwort verwenden, um zusätzliche erforderliche Zuordnungen abzurufen und diese Zuordnungen in Ihrer Anwendung überall dort anzuzeigen, wo das Bild angezeigt wird. Es werden maximal 10 Fotos zurückgegeben.

Bei mehreren Aufrufen dieser Methode werden wahrscheinlich jedes Mal dieselben Fotos zurückgegeben. Dies ist jedoch nicht garantiert, da sich die zugrunde liegenden Daten geändert haben können.

Diese Methode führt eine Netzwerksuche durch.

Parameter:
placeIDDie Orts-ID, für die Fotos gesucht werden sollen.
callbackDer Callback, der mit dem Suchergebnis aufgerufen werden soll.
- (void) ladenPlacePhoto: (GMSPlacePhotoMetadata *) photoMetadata
Callback: (GMSPlacePhotoImageResultCallback) Callback

Lädt das Bild für ein bestimmtes Foto in seiner maximalen Größe.

Bilddaten werden möglicherweise vom SDK im Cache gespeichert. Wenn das angeforderte Foto nicht im Cache vorhanden ist, wird ein Netzwerk-Lookup durchgeführt.

Parameter:
photoMetadataDas GMSPlacePhotoMetadata, für das ein UIImage geladen werden soll.
callbackDer Callback, der mit dem geladenen UIImage aufgerufen werden soll.
- (void) ladenPlacePhoto: (GMSPlacePhotoMetadata *) photoMetadata
restrictedToSize: (CGSize) maxSize
Skalierung: (CGFloat) skalieren
Callback: (GMSPlacePhotoImageResultCallback) Callback

Lädt das Bild für ein bestimmtes Foto, skaliert auf die vorgegebenen maximalen Abmessungen.

Das Bild wird unter Beibehaltung des Seitenverhältnisses des ursprünglichen Bildes so skaliert, dass es in die vorgegebenen Abmessungen passt. Diese Skalierung erfolgt serverseitig.

Wenn der Parameter "scale" nicht 1,0 ist, wird "maxSize" mit diesem Wert multipliziert und der zurückgegebene UIImage auf die angegebene Skalierung eingestellt. Dieser Parameter sollte auf die Bildschirmgröße festgelegt werden, wenn Sie Bilder zur Anzeige auf dem Bildschirm laden.

Bilddaten werden möglicherweise vom SDK im Cache gespeichert. Wenn das angeforderte Foto nicht im Cache vorhanden ist, wird ein Netzwerk-Lookup durchgeführt.

Hinweis:
Nach Anwendung des Skalierungsfaktors werden die Dimensionen in „maxSize“ vor der Verwendung auf die nächste Ganzzahl aufgerundet. Wenn ein Bild angefordert wird, das größer als die maximal verfügbare Größe ist, kann ein kleineres Bild zurückgegeben werden.
Parameter:
photoMetadataDas GMSPlacePhotoMetadata, für das ein UIImage geladen werden soll.
maxSizeDie maximale Größe des Bildes.
profitierenDie Waage, auf der das Bild geladen werden soll.
callbackDer Callback, der mit dem geladenen UIImage aufgerufen werden soll.

Gibt eine Schätzung des Ortes zurück, an dem sich das Gerät derzeit befindet.

Erstellt eine Wahrscheinlichkeitsliste für Orte basierend auf dem letzten ungefähren Standort des Geräts. Der bereitgestellte Callback wird mit dieser Wahrscheinlichkeitsliste bei Erfolg und ein NSError bei einem Fehler aufgerufen.

Hinweis:
Für diese Methode muss deine App die Berechtigung haben, auf den aktuellen Gerätestandort zuzugreifen. Bevor Sie diese Methode aufrufen, fordern Sie mithilfe von [CLLocationManager requestWhenInUseAuthorization] oder [CLLocationManager requestAlwaysAuthorization] Zugriff auf den Standort des Nutzers an. Wenn Sie diese Methode aufrufen und Ihre App nicht den korrekten Autorisierungsstatus hat, wird der Callback mit einem Fehler aufgerufen.
Parameter:
callbackDer Callback, der mit der Ortswahrscheinlichkeitsliste aufgerufen werden soll.
– (void) findAutocompletePredictionsFromQuery: (NSString *) query
Filter: (GMSAutocompleteFilter* darf Nullwerte enthalten) Filter
sessionToken: (GMSAutocompleteSessionToken* darf null sein) sessionToken
Callback: GMSAutocompletePredictionsCallback. Callback

Automatische Vervollständigung über eine Textabfrage finden.

Die Ergebnisse können optional auf einen bestimmten Standort ausgerichtet oder auf ein Gebiet beschränkt sein. Diese Methode blockiert nicht.

Der bereitgestellte Callback wird mit einem Array von automatischen Vervollständigungen bei Erfolg und einem NSError bei einem Fehler aufgerufen.

Parameter:
AbfrageDer Teiltext, der automatisch vervollständigt werden soll.
FilterDer Filter, der auf die Ergebnisse angewendet werden soll. Dieser Parameter kann null sein.
sessionTokenDie GMSAutocompleteSessionToken, um die Anfrage mit einer Abrechnungssitzung zu verknüpfen.
callbackDer Callback, der mit den Vorhersagen aufgerufen werden soll.
- (void) fetchPlaceFromPlaceID: (NSString *) placeID
„placeFields“: (GMSPlaceField) placeFields
sessionToken: (GMSAutocompleteSessionToken* darf null sein) sessionToken
Callback: (GMSPlaceResultCallback) Callback

Details zu einem Ort abrufen

Diese Methode blockiert nicht.

Parameter:
placeIDDie Orts-ID, nach der gesucht werden soll.
placeFieldsDie einzelnen Ortsfelder, die für die Ortsobjekte in der Liste angefordert werden
sessionTokenDie GMSAutocompleteSessionToken, um die Anfrage mit einer Abrechnungssitzung zu verknüpfen.
callbackDer Callback, der mit dem Suchergebnis aufgerufen werden soll.
- (void) findPlaceLikelihoodsFromCurrentLocationWithPlaceFields: (GMSPlaceField) placeFields
Callback: GMSPlaceLikelihoodsCallback Callback

Wahrscheinlichkeiten von Orten anhand des aktuellen Standorts des Nutzers ermitteln

Diese Methode blockiert nicht.

Der bereitgestellte Callback wird mit einem Array von Orten mit Wahrscheinlichkeitswerten bei Erfolg und einem NSError bei einem Fehler aufgerufen.

Parameter:
placeFieldsDie einzelnen Ortsfelder, die für die Ortsobjekte in der Liste angefordert werden
callbackDer Callback, der mit Ortswahrscheinlichkeiten aufgerufen werden soll.
- (void) isOpenWithPlaceID: (NSString *) placeID
Callback: (GMSPlaceOpenStatusCallback) Callback

Ruft Details zu einem Ort ab, einschließlich aller erforderlichen Felder, um GMSPlaceOpenStatus zum aktuellen Zeitpunkt zu bestimmen.

Diese Methode blockiert nicht.

Parameter:
placeIDDie Orts-ID, nach der gesucht werden soll.
callbackDer Callback, der mit dem Ortsergebnis aufgerufen werden soll.
- (void) isOpenWithPlaceID: (NSString *) placeID
Datum: (NSDate *) Datum
Callback: (GMSPlaceOpenStatusCallback) Callback

Ruft Details zu einem Ort ab, einschließlich aller erforderlichen Felder, um das GMSPlaceOpenStatus-Element an der angegebenen NSDate zu bestimmen.

Diese Methode blockiert nicht.

Parameter:
placeIDDie Orts-ID, nach der gesucht werden soll.
dateDas NSDate, für das der Öffnungsstatus bestimmt werden soll.
callbackDer Callback, der mit dem Ortsergebnis aufgerufen werden soll.
- (void) isOpenWithPlace: (GMSPlace *) Ort
Callback: (GMSPlaceOpenStatusCallback) Callback

Ruft Details zu einem Ort ab, einschließlich aller erforderlichen Felder, um GMSPlaceOpenStatus zum aktuellen Zeitpunkt zu bestimmen.

Fordert nur dann zusätzliche Felder an, wenn GMSPlace nicht alle erforderlichen Felder enthält. Andernfalls wird GMSPlaceOpenStatus sofort im Callback zurückgegeben. Diese Methode blockiert nicht.

Parameter:
OrtDie nachzuschlagende GMSPlace.
callbackDer Callback, der mit dem Ortsergebnis aufgerufen werden soll.
- (void) isOpenWithPlace: (GMSPlace *) Ort
Datum: (NSDate *) Datum
Callback: (GMSPlaceOpenStatusCallback) Callback

Ruft Details zu einem Ort ab, einschließlich aller erforderlichen Felder, um das GMSPlaceOpenStatus-Element an der angegebenen NSDate zu bestimmen.

Fordert nur dann zusätzliche Felder an, wenn GMSPlace nicht alle erforderlichen Felder enthält, andernfalls 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-Ergebnis, NSError *_Nullable-Fehler)) [related]

Callback-Typ für den Empfang von Lookups für Ortsdetails.

Wenn ein Fehler aufgetreten ist, ist result null und error enthält Informationen zum Fehler.

Parameter:
ErgebnisDie zurückgegebene GMSPlace.
errorDer aufgetretene Fehler, falls vorhanden.
- (typedef void(^ GMSPlaceLikelihoodListCallback)(GMSPlaceLikelihoodList *_Nullable LikeList, NSError *_Nullable error)) [related]

Callback-Typ für den Empfang von Ortswahrscheinlichkeitslisten.

Wenn ein Fehler aufgetreten ist, ist likelihoodList null und error enthält Informationen zum Fehler.

Parameter:
likelihoodListDie Liste der Wahrscheinlichkeiten von Orten.
errorDer aufgetretene Fehler, falls vorhanden.
- (typedef void(^ GMSPlaceLikelihoodsCallback)(NSArray< GMSPlaceLikelihood * > *_Nullable Likes, NSError *_Nullable error)) [related]

Callback-Typ für den Empfang eines Arrays mit GMSPlaceLikelihood-Werten.

Wenn ein Fehler aufgetreten ist, ist das Array null und error enthält Informationen zum Fehler.

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

Callback-Typ für den Empfang von Ergebnissen der automatischen Vervollständigung.

results ist ein Array von GMSAutocompletePredictions, die Kandidatenvervollständigungen der Abfrage darstellen.

Parameter:
ErgebnisseEin Array mit GMSAutocompletePrediction-Werten.
errorDer aufgetretene Fehler, falls vorhanden.
- (typedef void(^ GMSPlacePhotoMetadataResultCallback)(GMSPlacePhotoMetadataList *_Nullable photos, NSError *_Nullable error)) [related]

Callback-Typ für den Empfang von Ergebnissen für Ortsfotos.

Wenn ein Fehler aufgetreten ist, ist photos null und error enthält Informationen zum Fehler.

Parameter:
fotosDas Ergebnis, das GMSPlacePhotoMetadata-Objekte enthält.
errorDer aufgetretene Fehler, falls vorhanden.
- (typedef void(^ GMSPlacePhotoImageResultCallback)(UIImage *_Nullable photo, NSError *_Nullable error)) [related]

Callback-Typ für den Empfang von UIImage-Objekten von einem GMSPlacePhotoMetadata-Objekt.

Wenn ein Fehler aufgetreten ist, ist photo null und error enthält Informationen zum Fehler.

Parameter:
fotoDas UIImage, das geladen wurde.
errorDer aufgetretene Fehler, falls vorhanden.
- (typedef void(^ GMSPlaceOpenStatusCallback)(GMSPlaceOpenStatus-Ergebnis, NSError *_Nullable-Fehler)) [related]

Callback-Typ, mit dem der Status der Öffnungszeiten des Orts abgerufen wird

Wenn ein Fehler aufgetreten ist, lautet result „GMSPlaceOpenStatusUnknown“ und error enthält Informationen zum Fehler.

Parameter:
ErgebnisDie zurückgegebene GMSPlaceOpenStatus.
errorDer aufgetretene Fehler, falls vorhanden.