Referensi Class GMSPlacesClient


Ringkasan

Antarmuka utama untuk Places SDK.

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

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 pada thread utama.

Fungsi Anggota Publik

(void) - lookUpPlaceID:callback:
 Mendapatkan detail suatu tempat.
(void) - lookUpPhotosForPlaceID:callback:
 Mendapatkan metadata hingga 10 foto yang terkait dengan 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 diberikan.
(void) - currentPlaceWithCallback:
 Menampilkan perkiraan tempat perangkat saat ini diketahui berada.
(void) - findAutocompletePredictionsFromQuery:filter:sessionToken:callback:
 Menemukan prediksi Autocomplete dari kueri teks.
(void) - fetchPlaceFromPlaceID:placeFields:sessionToken:callback:
 Mengambil detail suatu tempat.
(void) - findPlaceLikelihoodsFromCurrentLocationWithPlaceFields:callback:
 Menemukan kemungkinan tempat menggunakan lokasi pengguna saat ini.
(void) - isOpenWithPlaceID:callback:
 Mendapatkan detail tempat termasuk semua kolom yang diperlukan untuk menentukan GMSPlaceOpenStatus pada saat ini.
(void) - isOpenWithPlaceID:date:callback:
 Mendapatkan detail tempat termasuk semua kolom yang diperlukan untuk menentukan GMSPlaceOpenStatus di NSDate yang ditentukan.
(void) - isOpenWithPlace:callback:
 Mendapatkan detail tempat termasuk semua kolom yang diperlukan untuk menentukan GMSPlaceOpenStatus pada saat ini.
(void) - isOpenWithPlace:date:callback:
 Mendapatkan detail tempat termasuk semua kolom yang diperlukan untuk menentukan GMSPlaceOpenStatus di NSDate yang ditentukan.

Fungsi Anggota Publik Statis

(instancetype)+ sharedClient
 Memberikan instance bersama GMSPlacesClient untuk Google Places SDK for iOS, yang membuatnya jika perlu.
(BOOL) + provideAPIKey:
 Memberikan 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, error NSError *_Nullable)
 Jenis callback untuk menerima pencarian detail tempat.
typedef void(^ GMSPlaceLikelihoodListCallback )(GMSPlaceLikelihoodList *_Nullable nullabilityList, error NSError *_Nullable)
 Jenis callback untuk menerima daftar kemungkinan tempat.
typedef void(^ GMSPlaceLikelihoodsCallback )(NSArray< GMSPlaceLikelihood * > kemungkinan *_Nullable, error NSError *_Nullable)
 Jenis callback untuk menerima array GMSPlaceLikelihood.
typedef void(^ GMSAutocompletePredictionsCallback )(NSArray< GMSAutocompletePrediction * > hasil *_Nullable, error NSError *_Nullable)
 Jenis callback untuk menerima hasil pelengkapan otomatis.
typedef void(^ GMSPlacePhotoMetadataResultCallback )(GMSPlacePhotoMetadataList *_Nullable foto, NSError *_Nullable error)
 Jenis callback untuk menerima hasil foto tempat.
typedef void(^ GMSPlacePhotoImageResultCallback )(UIImage *_Nullable foto, error NSError *_Nullable)
 Jenis callback untuk menerima objek UIImage dari objek GMSPlacePhotoMetadata.
typedef void(^ GMSPlaceOpenStatusCallback )(hasil GMSPlaceOpenStatus, error NSError *_Nullable)
 Jenis callback untuk menerima status jam buka untuk Tempat.

Dokumentasi Fungsi Anggota

+ (instancetype) sharedClient

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

Jika aplikasi Anda sering menggunakan metode GMSPlacesClient, sebaiknya pertahankan objek ini secara langsung, atau koneksi Anda ke Google dapat dimulai ulang secara rutin.

+ (BOOL) provideAPIKey: (NSString *) key

Memberikan kunci API Anda ke Google Places SDK for iOS.

Kunci ini dibuat untuk aplikasi Anda melalui Google Cloud Platform Console dan disambungkan dengan ID paket aplikasi untuk mengidentifikasinya. Layanan 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
: (GMSPlaceResultCallback) callback

Mendapatkan detail suatu tempat.

Metode ini bersifat non-pemblokiran.

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

Mendapatkan metadata hingga 10 foto yang terkait dengan tempat.

Foto berasal dari berbagai lokasi, termasuk pemilik bisnis dan foto yang dikontribusikan oleh pengguna Google+. Umumnya, foto ini dapat digunakan tanpa atribusi, atau harus 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 dalam aplikasi di mana pun Anda menampilkan gambar. Maksimum 10 foto dikembalikan.

Beberapa panggilan metode ini mungkin akan mengembalikan foto yang sama setiap saat. Namun, hal ini tidak dijamin karena data pokoknya mungkin telah berubah.

Metode ini melakukan pencarian jaringan.

Parameter:
placeIDID tempat yang fotonya dicari.
callbackCallback yang akan dipanggil dengan hasil pencarian.
- (void) loadPlacePhoto: (GMSPlacePhotoMetadata *) photoMetadata
: (GMSPlacePhotoImageResultCallback) callback

Memuat gambar untuk foto tertentu pada ukuran maksimumnya.

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

Parameter:
photoMetadataGMSPlacePhotoMetadata untuk memuat UIImage.
callbackCallback yang akan dipanggil dengan UIImage yang dimuat.
- (void) loadPlacePhoto: (GMSPlacePhotoMetadata *) photoMetadata
RestrictedToSize: (CGSize) maxSize
skala: (CGFloat) skala
: (GMSPlacePhotoImageResultCallback) callback

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

Gambar akan diskalakan agar sesuai dengan dimensi yang diberikan dengan tetap mempertahankan rasio aspek gambar aslinya. Penskalaan ini dijalankan di sisi server.

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

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

Catatan:
Setelah menerapkan faktor skala, dimensi dalam maxSize akan dibulatkan ke bilangan bulat terdekat sebelum digunakan. Jika gambar yang diminta lebih besar dari ukuran maksimum yang tersedia, gambar yang lebih kecil dapat ditampilkan.
Parameter:
photoMetadataGMSPlacePhotoMetadata untuk 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 saat terjadi error.

Catatan:
Metode ini mengharuskan aplikasi Anda memiliki izin untuk mengakses lokasi perangkat saat ini. Sebelum memanggilnya, 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 pesan error.
Parameter:
callbackCallback yang akan dipanggil dengan daftar kemungkinan tempat.
- (void) findAutocompletePredictionsFromQuery: (NSString *) query
filter: (nullable GMSAutocompleteFilter *) filter
sessionToken: (nullable GMSAutocompleteSessionToken *) sessionToken
: (GMSAutocompletePredictionsCallback) callback

Menemukan prediksi Autocomplete dari kueri teks.

Hasilnya dapat dicondongkan ke lokasi tertentu atau dibatasi pada suatu area. Metode ini bersifat non-pemblokiran.

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

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

Mengambil detail suatu tempat.

Metode ini bersifat non-pemblokiran.

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

Menemukan kemungkinan tempat menggunakan lokasi pengguna saat ini.

Metode ini bersifat non-pemblokiran.

Callback yang diberikan akan dipanggil bersama array tempat dengan skor kemungkinan setelah berhasil dan NSError saat terjadi error.

Parameter:
placeFieldsSetiap kolom tempat diminta untuk objek tempat dalam daftar.
callbackCallback yang akan dipanggil dengan kemungkinan tempat.
- (void) isOpenWithPlaceID: (NSString *) placeID
: (GMSPlaceOpenStatusCallback) callback

Mendapatkan detail tempat termasuk semua kolom yang diperlukan untuk menentukan GMSPlaceOpenStatus pada saat ini.

Metode ini bersifat non-pemblokiran.

Parameter:
placeIDID tempat yang akan dicari.
callbackCallback yang akan dipanggil dengan hasil tempat.
- (void) isOpenWithPlaceID: (NSString *) placeID
tanggal: (NSDate *) tanggal
: (GMSPlaceOpenStatusCallback) callback

Mendapatkan detail tempat termasuk semua kolom yang diperlukan untuk menentukan GMSPlaceOpenStatus di NSDate yang ditentukan.

Metode ini bersifat non-pemblokiran.

Parameter:
placeIDID tempat yang akan dicari.
dateNSDate untuk menentukan status terbuka.
callbackCallback yang akan dipanggil dengan hasil tempat.
- (void) isOpenWithPlace: (GMSPlace *) tempat
: (GMSPlaceOpenStatusCallback) callback

Mendapatkan detail tempat termasuk semua kolom yang diperlukan untuk menentukan GMSPlaceOpenStatus pada saat ini.

Hanya minta kolom tambahan jika GMSPlace tidak memiliki semua kolom yang diperlukan. Jika tidak, GMSPlaceOpenStatus akan segera ditampilkan di callback. Metode ini bersifat non-pemblokiran.

Parameter:
tempatGMSPlace untuk dicari.
callbackCallback yang akan dipanggil dengan hasil tempat.
- (void) isOpenWithPlace: (GMSPlace *) tempat
tanggal: (NSDate *) tanggal
: (GMSPlaceOpenStatusCallback) callback

Mendapatkan detail tempat termasuk semua kolom yang diperlukan untuk menentukan GMSPlaceOpenStatus di NSDate yang ditentukan.

Hanya meminta kolom tambahan jika GMSPlace tidak memiliki semua kolom yang diperlukan. Jika tidak, 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 hasil, error NSError *_Nullable)) [related]

Jenis callback untuk menerima pencarian detail tempat.

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

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

Jenis callback untuk menerima daftar kemungkinan tempat.

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

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

Jenis callback untuk menerima array GMSPlaceLikelihood.

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

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

Jenis callback untuk menerima hasil pelengkapan otomatis.

results adalah array GMSAutocompletePredictions yang mewakili penyelesaian kueri sebagai kandidat.

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

Jenis callback untuk menerima hasil foto tempat.

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

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 nol dan error akan berisi informasi tentang error tersebut.

Parameter:
fotoUIImage yang telah dimuat.
errorError yang terjadi, jika ada.
- (typedef void(^ GMSPlaceOpenStatusCallback)(hasil GMSPlaceOpenStatus, error NSError *_Nullable)) [related]

Jenis callback untuk menerima status jam buka untuk Tempat.

Jika terjadi error, result akan menjadi GMSPlaceOpenStatusUnknown dan error akan berisi informasi tentang error.

Parameter:
hasilGMSPlaceOpenStatus yang ditampilkan.
errorError yang terjadi, jika ada.