Referensi Class GMSPlacesClient


Ringkasan

Antarmuka utama ke Places SDK.

Digunakan untuk menelusuri dan mendapatkan detail tentang tempat. Class ini harus diakses melalui metode [GMSPlacesClient sharedClient].

Metode GMSPlacesClient hanya boleh dipanggil dari thread utama. Memanggil metode ini dari thread lain akan menghasilkan pengecualian atau perilaku yang tidak ditentukan. Kecuali jika ditentukan lain, semua callback akan dipanggil di thread utama.

Fungsi Anggota Publik

(void)- lookUpPlaceID:callback:
 Mendapatkan detail suatu tempat.
(void)- lookUpPhotosForPlaceID:callback:
 Mendapatkan metadata untuk maksimal 10 foto yang terkait dengan suatu tempat.
(void)- loadPlacePhoto:callback:
 Memuat gambar untuk foto tertentu pada ukuran maksimumnya.
(void)- loadPlacePhoto:constrainedToSize:scale:callback:
 Memuat gambar untuk foto tertentu, yang diskalakan agar sesuai dengan dimensi maksimum yang ditentukan.
(void)- currentPlaceWithCallback:
 Menampilkan perkiraan tempat perangkat saat ini diketahui berada.
(void)- findAutocompletePredictionsFromQuery:filter:sessionToken:callback:
 Menemukan prediksi Pelengkapan Otomatis dari kueri teks.
(void)- fetchPlaceFromPlaceID:placeFields:sessionToken:callback:
 Mengambil detail tempat.
(void)- findPlaceLikelihoodsFromCurrentLocationWithPlaceFields:callback:
 Menemukan kemungkinan tempat menggunakan lokasi pengguna saat ini.

Fungsi Anggota Publik Statis

(instancetype)+ sharedClient
 Menyediakan instance bersama GMSPlacesClient untuk Google Places SDK for iOS, membuatnya jika perlu.
(BOOL)+ provideAPIKey:
 Menyediakan kunci API Anda ke Google Places SDK for iOS.
(NSString *)+ openSourceLicenseInfo
 Menampilkan informasi lisensi software open source untuk Google Places SDK for iOS.
(NSString *)+ SDKVersion
 Menampilkan versi untuk rilis Google Places SDK for iOS ini.
(NSString *)+ SDKLongVersion
 Menampilkan versi panjang untuk rilis Google Places SDK for iOS ini.

(Perhatikan bahwa ini bukan fungsi anggota.)

typedef void(^ GMSPlaceResultCallback ](GMSPlace *_Nullable hasil, NSError *_Nullable error)
 Jenis callback untuk menerima pencarian detail tempat.
typedef void(^ GMSPlaceLikelihoodListCallback )(GMSPlaceLikelihoodList *_Nullable kemungkinanList, NSError *_Nullable error)
 Jenis callback untuk menerima daftar kemungkinan tempat.
typedef void(^ GMSPlaceLikelihoodsCallback )(NSArray< GMSPlaceLikelihood * > *_Kemungkinan besar, NSError *_Nullable error)
 Jenis callback untuk menerima array GMSPlaceLikelihood.
typedef void(^ GMSAutocompletePredictionsCallback )(NSArray< GMSAutocompletePrediction * > *_Nullable hasil, NSError *_Nullable error)
 Jenis callback untuk menerima hasil pelengkapan otomatis.
typedef void(^ GMSPlacePhotoMetadataResultCallback )(GMSPlacePhotoMetadataList *_Nullable photos, NSError *_Nullable error)
 Jenis callback untuk menerima hasil foto tempat.
typedef void(^ GMSPlacePhotoImageResultCallback )(UIImage *_Nullable photo, NSError *_Nullable error)
 Jenis callback untuk menerima objek UIImage dari objek GMSPlacePhotoMetadata.

Dokumentasi Fungsi Anggota

+ (instancetype) sharedClient

Menyediakan instance bersama GMSPlacesClient untuk Google Places SDK for iOS, membuatnya jika perlu.

Jika aplikasi Anda sering menggunakan metode GMSPlacesClient, sebaiknya tahan objek ini secara langsung, karena jika tidak, koneksi Anda ke Google dapat dimulai ulang secara berkala.

+ (BOOL) provideAPIKey: (NSString *) kunci

Menyediakan kunci API Anda ke Google Places SDK for iOS.

Kunci ini dibuat untuk aplikasi Anda melalui Google Cloud Platform Console, dan dipasangkan dengan ID paket aplikasi untuk mengidentifikasinya. Ini harus dipanggil oleh aplikasi Anda sebelum menggunakan GMSPlacesClient (misalnya, dalam application:didFinishLaunchingWithOptions:).

Hasil:
YA jika APIKey berhasil diberikan.
+ (NSString *) openSourceLicenseInfo

Menampilkan informasi lisensi software open source untuk Google Places SDK for iOS.

Informasi ini harus disediakan dalam permohonan Anda.

+ (NSString *) SDKVersion

Menampilkan versi untuk rilis Google Places SDK for iOS ini.

. Misalnya, "1.0.0".

+ (NSString *) SDKLongVersion

Menampilkan versi panjang untuk rilis Google Places SDK for iOS ini.

. Misalnya, "1.0.0 (102.1)".

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

Mendapatkan detail suatu tempat.

Metode ini tidak memblokir.

Parameter:
ID tempatID tempat yang akan dicari.
callbackCallback yang akan dipanggil dengan hasil pencarian.
- (void) lookUpPhotosForPlaceID: (NSString *) placeID
callback: (GMSPlacePhotoMetadataResultCallback) callback

Mendapatkan metadata untuk maksimal 10 foto yang terkait dengan suatu tempat.

Foto diambil dari berbagai lokasi, termasuk pemilik bisnis dan foto yang dikontribusikan oleh pengguna Google+. Umumnya, foto ini dapat digunakan tanpa atribusi, atau menyertakan atribusi yang diperlukan sebagai bagian dari gambar. Namun, Anda harus menggunakan properti attributions dalam respons untuk mengambil atribusi tambahan yang diperlukan, dan menampilkan atribusi tersebut di aplikasi Anda di mana pun Anda menampilkan gambar. Maksimum 10 foto ditampilkan.

Beberapa panggilan untuk metode ini mungkin akan selalu menampilkan foto yang sama. Namun, hal ini tidak dijamin karena data pokok mungkin telah berubah.

Metode ini melakukan pencarian jaringan.

Parameter:
ID tempatID tempat untuk mencari foto.
callbackCallback yang akan dipanggil dengan hasil pencarian.
- (void) loadPlacePhoto: (GMSPlacePhotoMetadata *) fotoMetadata
callback: (GMSPlacePhotoImageResultCallback) callback

Memuat gambar untuk foto tertentu pada ukuran maksimumnya.

Data gambar mungkin di-cache oleh SDK. Jika foto yang diminta tidak ada di cache, pencarian jaringan akan dilakukan.

Parameter:
fotoMetadataGMSPlacePhotoMetadata yang akan memuat UIImage.
callbackCallback yang akan dipanggil dengan UIImage yang dimuat.
- (void) loadPlacePhoto: (GMSPlacePhotoMetadata *) fotoMetadata
constrainedToSize: (CGSize) maxSize
skala: (CGFloat) skala
callback: (GMSPlacePhotoImageResultCallback) callback

Memuat gambar untuk foto tertentu, yang diskalakan agar sesuai dengan dimensi maksimum yang ditentukan.

Gambar akan diskalakan agar sesuai dengan dimensi yang ditentukan dengan tetap mempertahankan rasio aspek gambar asli. Penskalaan ini dilakukan di sisi server.

Jika parameter skala bukan 1,0 maxSize akan dikalikan dengan nilai ini dan UIImage yang ditampilkan akan ditetapkan agar memiliki skala yang ditentukan. Parameter ini harus disetel ke skala layar jika Anda memuat gambar untuk ditampilkan di layar.

Data gambar mungkin di-cache oleh SDK. Jika foto yang diminta tidak ada di cache, pencarian jaringan akan dilakukan.

Catatan:
Setelah menerapkan faktor skala, dimensi dalam maxSize akan dibulatkan ke bilangan bulat terdekat sebelum digunakan. Jika gambar diminta dengan ukuran lebih besar dari ukuran maksimum yang tersedia, gambar yang lebih kecil mungkin akan ditampilkan.
Parameter:
fotoMetadataGMSPlacePhotoMetadata yang akan memuat UIImage.
maxSizeUkuran maksimum gambar.
scaleSkala untuk memuat gambar.
callbackCallback yang akan dipanggil dengan UIImage yang dimuat.

Menampilkan perkiraan tempat perangkat saat ini diketahui berada.

Menghasilkan daftar kemungkinan tempat berdasarkan perkiraan lokasi terakhir perangkat. Callback yang disediakan akan dipanggil dengan daftar kemungkinan ini setelah berhasil dan NSError pada saat error.

Catatan:
Metode ini mengharuskan aplikasi Anda memiliki izin untuk mengakses lokasi perangkat saat ini. Sebelum memanggil ini, pastikan untuk meminta akses ke lokasi pengguna menggunakan [CLLocationManager requestWhenInUseAuthorization] atau [CLLocationManager requestAlwaysAuthorization]. Jika Anda memanggil metode ini dan aplikasi Anda tidak memiliki status otorisasi yang benar, callback akan dipanggil dengan menampilkan error.
Parameter:
callbackCallback yang akan dipanggil dengan daftar kemungkinan tempat.
- (void) findAutocompletePredictionsFromQuery: (NSString *) kueri
: (GMSAutocompleteFilter nullable *) filter
sessionToken: (GMSAutocompleteSessionToken nullable *) sessionToken
callback: (GMSAutocompletePredictionsCallback) callback

Menemukan prediksi Pelengkapan Otomatis dari kueri teks.

Secara opsional, hasil dapat dibiaskan ke lokasi tertentu atau dibatasi ke area. Metode ini tidak memblokir.

Callback yang disediakan akan dipanggil dengan array prediksi pelengkapan otomatis setelah berhasil dan NSError pada saat error.

Parameter:
kueriTeks parsial untuk pelengkapan otomatis.
filterFilter yang akan diterapkan ke hasil. Parameter ini dapat bernilai nil.
sessionTokenGMSAutocompleteSessionToken untuk mengaitkan permintaan ke sesi penagihan.
callbackCallback yang akan dipanggil dengan prediksi.
- (void) fetchPlaceFromPlaceID: (NSString *) placeID
placeFields: (GMSPlaceField) placeFields
sessionToken: (GMSAutocompleteSessionToken nullable *) sessionToken
callback: (GMSPlaceResultCallback) callback

Mengambil detail tempat.

Metode ini tidak memblokir.

Parameter:
ID tempatID tempat yang akan dicari.
placeFieldsSetiap kolom tempat meminta objek tempat dalam daftar.
sessionTokenGMSAutocompleteSessionToken untuk mengaitkan permintaan ke sesi penagihan.
callbackCallback yang akan dipanggil dengan hasil pencarian.
- (void) findPlaceLikelihoodsFromCurrentLocationWithPlaceFields: (GMSPlaceField) placeFields
callback: (GMSPlaceLikelihoodsCallback) callback

Menemukan kemungkinan tempat menggunakan lokasi pengguna saat ini.

Metode ini tidak memblokir.

Callback yang disediakan akan dipanggil dengan array tempat dengan skor kemungkinan saat berhasil dan NSError pada saat error.

Parameter:
placeFieldsSetiap kolom tempat meminta objek tempat dalam daftar.
callbackCallback yang akan dipanggil dengan kemungkinan tempat.

- (typedef void(^ GMSPlaceResultCallback)(GMSPlace *_Hasil yang dapat null, NSError *_Nullable error)) [related]

Jenis callback untuk menerima pencarian detail tempat.

Jika terjadi error, result akan bernilai nil dan error akan berisi informasi tentang error.

Parameter:
hasilGMSPlace yang ditampilkan.
errorError yang terjadi, jika ada.
- (typedef void(^ GMSPlaceLikelihoodListCallback)(GMSPlaceLikelihoodList *_Nullable kemungkinanList, NSError *_Nullable error)) [related]

Jenis callback untuk menerima daftar kemungkinan tempat.

Jika terjadi error, likelihoodList akan bernilai nil dan error akan berisi informasi tentang error.

Parameter:
kemungkinanDaftarDaftar kemungkinan tempat.
errorError yang terjadi, jika ada.
- (typedef void(^ GMSPlaceLikelihoodsCallback)(NSArray< GMSPlaceLikelihood * > *_Kemungkinan yang dapat dibatalkan, NSError *_Nullable error)) [related]

Jenis callback untuk menerima array GMSPlaceLikelihood.

Jika terjadi error, array akan bernilai nil dan error akan berisi informasi tentang error tersebut.

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

Jenis callback untuk menerima hasil pelengkapan otomatis.

results adalah array GMSAutocompletePredictions yang mewakili kandidat penyelesaian kueri.

Parameter:
hasilArray GMSAutocompletePrediction.
errorError yang terjadi, jika ada.
- (typedef void(^ GMSPlacePhotoMetadataResultCallback)(GMSPlacePhotoMetadataList *_Nullable photos, NSError *_Nullable error)) [related]

Jenis callback untuk menerima hasil foto tempat.

Jika terjadi error, photos akan bernilai nil dan error akan berisi informasi tentang error.

Parameter:
fotoHasil yang berisi objek GMSPlacePhotoMetadata.
errorError yang terjadi, jika ada.
- (typedef void(^ GMSPlacePhotoImageResultCallback)(UIImage *_Nullable photo, NSError *_Nullable error)) [related]

Jenis callback untuk menerima objek UIImage dari objek GMSPlacePhotoMetadata.

Jika terjadi error, photo akan bernilai nil dan error akan berisi informasi tentang error.

Parameter:
fotoUIImage yang telah dimuat.
errorError yang terjadi, jika ada.