Tài liệu tham khảo về lớp GMSPlaceClient

Tài liệu tham khảo về lớp GMSPlaceClient

Tổng quan

Giao diện chính của SDK Địa điểm.

Dùng để tìm kiếm và xem thông tin chi tiết về các địa điểm. Bạn nên truy cập vào lớp này thông qua phương thức [GMSPlacesClient sharedClient].

Bạn chỉ nên gọi phương thức GMSPlacesClient từ chuỗi chính. Việc gọi các phương thức này từ một luồng khác sẽ dẫn đến ngoại lệ hoặc hành vi không xác định. Trừ phi có quy định khác, tất cả các lệnh gọi lại sẽ được gọi trên luồng chính.

Hàm thành viên công khai

(void) lookUpPlaceID:callback:
 Xem thông tin chi tiết về một địa điểm.
(void) lookUpPhotosForPlaceID:callback:
 Lấy siêu dữ liệu cho tối đa 10 ảnh liên kết với một địa điểm.
(void) loadPlaceImage:callback:
 Tải hình ảnh cho một ảnh cụ thể ở kích thước tối đa.
(void) loadPlacePhoto:constrainedToSize:scale:callback:
 Tải hình ảnh cho một ảnh cụ thể, được điều chỉnh theo tỷ lệ để vừa với kích thước tối đa đã cho.
(void) currentPlaceWithCallback:
 Trả về thông tin ước tính về địa điểm hiện đã xác định được vị trí của thiết bị.
(void) - findAutocompletePredictionsFromQuery:filter:sessionToken:callback:
 Tìm các cụm từ gợi ý của tính năng Tự động hoàn thành trong cụm từ tìm kiếm.
(void) fetchPlaceFromPlaceID:placeFields:sessionToken:callback:
 Tìm nạp thông tin chi tiết cho một địa điểm.
(void) findPlaceLikelihoodsFromCurrentLocationWithPlaceFields:callback:
 Tìm khả năng xuất hiện của địa điểm bằng cách sử dụng vị trí hiện tại của người dùng.
(void) isOpenWithPlaceID:callback:
 Lấy thông tin chi tiết về một địa điểm, bao gồm tất cả các trường cần thiết để xác định GMSPlaceOpenStatus ở thời điểm hiện tại.
(void) isOpenWithPlaceID:date:callback:
 Lấy thông tin chi tiết về một địa điểm, bao gồm tất cả các trường cần thiết để xác định GMSPlaceOpenStatus tại NSDate được chỉ định.
(void) isOpenWithPlace:callback:
 Lấy thông tin chi tiết về một địa điểm, bao gồm tất cả các trường cần thiết để xác định GMSPlaceOpenStatus ở thời điểm hiện tại.
(void) isOpenWithPlace:date:callback:
 Lấy thông tin chi tiết về một địa điểm, bao gồm tất cả các trường cần thiết để xác định GMSPlaceOpenStatus tại NSDate được chỉ định.

Hàm thành viên công khai tĩnh

(loại thực thể)+ sharedClient
 Cung cấp phiên bản chia sẻ của GMSPlacesClient cho SDK Google địa điểm dành cho iOS, tạo phiên bản này nếu cần.
(BOOL) + cung cấpAPIKey:
 Cung cấp khoá API cho SDK Google Địa điểm dành cho iOS.
(NSString *)+ openSourceLicenseInfo
 Trả về thông tin giấy phép phần mềm nguồn mở cho SDK Google Địa điểm dành cho iOS.
(NSString *)+ SDKVersion (Phiên bản SDK)
 Trả về phiên bản của bản phát hành này của SDK Google Địa điểm dành cho iOS.
(NSString *)+ SDKLongVersion
 Trả về phiên bản dài của bản phát hành Google Địa điểm SDK dành cho iOS này.

(Lưu ý rằng đây không phải là hàm thành phần.)

khoảng trống typedef(^ GMSPlaceResultCallback )(GMSPlace *_Kết quả có thể rỗng, NSError *_Lỗi có thể rỗng)
 Loại lệnh gọi lại để nhận thông tin tra cứu thông tin chi tiết về địa điểm.
khoảng trống typedef(^ GMSPlaceLikelihoodListCallback )(GMSPlaceLikelihoodList *_Nullable suggestedList, NSError *_Nullable error)
 Loại lệnh gọi lại để nhận danh sách khả năng của địa điểm.
khoảng trống typedef(^ GMSPlaceLikelihoodsCallback )(NSArray< GMSPlaceLikelihood * > *_Nullable khả năng, NSError *_Nullable error)
 Loại lệnh gọi lại để nhận mảng GMSPlaceLikelihood.
khoảng trống typedef(^ GMSAutocompletePredictionsCallback )(NSArray< GMSAutocompletePrediction * > *_Nullable kết quả, NSError *_Nullable error)
 Loại lệnh gọi lại để nhận kết quả tự động hoàn thành.
khoảng trống typedef(^ GMSPlacePhotoMetadataResultCallback )(GMSPlacePhotoMetadataList *_Ảnh có giá trị rỗng, NSError *_Nullable error)
 Loại lệnh gọi lại để nhận kết quả hình ảnh địa điểm.
khoảng trống typedef(^ GMSPlacePhotoImageResultCallback )(UIImage *_Ảnh có thể có giá trị rỗng, NSError *_Lỗi có thể chuyển đổi)
 Loại lệnh gọi lại để nhận các đối tượng UIImage từ đối tượng GMSPlacePhotoMetadata.
khoảng trống typedef(^ GMSPlaceOpenStatusCallback )(kết quả GMSPlaceOpenStatus, NSError *_Nullable error)
 Loại lệnh gọi lại để nhận trạng thái giờ mở cửa cho Địa điểm.

Tài liệu về hàm thành phần

+ (instancetype) sharedClient

Cung cấp phiên bản chia sẻ của GMSPlacesClient cho SDK Google địa điểm dành cho iOS, tạo phiên bản này nếu cần.

Nếu ứng dụng của bạn thường sử dụng các phương thức GMSPlacesClient, thì ứng dụng có thể muốn giữ trực tiếp đối tượng này, nếu không, kết nối của bạn với Google có thể được khởi động lại thường xuyên.

+ (BOOL) provideAPIKey: (NSString *) khoá

Cung cấp khoá API cho SDK Google Địa điểm dành cho iOS.

Khoá này được tạo cho ứng dụng của bạn thông qua Bảng điều khiển Google Cloud Platform và được ghép nối với mã nhận dạng gói của ứng dụng để xác định khoá này. Ứng dụng của bạn sẽ gọi mã này trước khi sử dụng GMSPlacesClient (ví dụ: trong application:didFinishLaunchingWithOptions:).

Trả về:
CÓ nếu bạn cung cấp thành công APIKey.
+ (NSString *) openSourceLicenseInfo

Trả về thông tin giấy phép phần mềm nguồn mở cho SDK Google Địa điểm dành cho iOS.

Thông tin này phải có sẵn trong đơn đăng ký của bạn.

+ (NSString *) SDKVersion

Trả về phiên bản của bản phát hành này của SDK Google Địa điểm dành cho iOS.

. Ví dụ: "1.0.0".

+ (NSString *) SDKLongVersion

Trả về phiên bản dài của bản phát hành Google Địa điểm SDK dành cho iOS này.

. Ví dụ: "1.0.0 (102.1)".

– (vô hiệu) LookUpPlaceID: (NSString *) placeID
lệnh gọi lại: (GMSPlaceResultCallback) lệnh gọi lại

Xem thông tin chi tiết về một địa điểm.

Phương thức này không chặn.

Các tham số:
placeIDMã địa điểm cần tra cứu.
số gọi lạiLệnh gọi lại để gọi kết quả tra cứu.
- (vô hiệu) LookUpPhotosForPlaceID: (NSString *) placeID
lệnh gọi lại: (GMSPlacePhotoMetadataResultCallback) lệnh gọi lại

Lấy siêu dữ liệu cho tối đa 10 ảnh liên kết với một địa điểm.

Ảnh được lấy từ nhiều địa điểm, bao gồm cả chủ doanh nghiệp và ảnh do người dùng Google+ đóng góp. Trong hầu hết trường hợp, những bức ảnh này có thể được sử dụng mà không cần ghi nhận tác giả hoặc sẽ có ghi nhận tác giả bắt buộc trong hình ảnh. Tuy nhiên, bạn phải sử dụng thuộc tính attributions trong phản hồi để truy xuất mọi thuộc tính bổ sung cần thiết, đồng thời hiển thị các thuộc tính đó trong ứng dụng của mình ở bất cứ nơi nào hình ảnh hiển thị. Bạn chỉ được trả lại tối đa 10 ảnh.

Nhiều lệnh gọi phương thức này có thể sẽ trả về cùng một ảnh mỗi lần. Tuy nhiên, chúng tôi không đảm bảo điều này vì dữ liệu cơ bản có thể đã thay đổi.

Phương thức này thực hiện việc tra cứu mạng.

Các tham số:
placeIDMã địa điểm cần tra cứu ảnh.
số gọi lạiLệnh gọi lại để gọi kết quả tra cứu.
- (vô hiệu) loadPlaceImage: (GMSPlacePhotoMetadata *) photoMetadata
lệnh gọi lại: (GMSPlacePhotoImageResultCallback) lệnh gọi lại

Tải hình ảnh cho một ảnh cụ thể ở kích thước tối đa.

SDK có thể lưu dữ liệu hình ảnh vào bộ nhớ đệm. Nếu ảnh được yêu cầu không tồn tại trong bộ nhớ đệm thì hoạt động tra cứu mạng sẽ được thực hiện.

Các tham số:
photoMetadataGMSPlacePhotoMetadata để tải một UIImage.
số gọi lạiLệnh callback để gọi bằng UIImage đã tải.
- (vô hiệu) loadPlaceImage: (GMSPlacePhotoMetadata *) photoMetadata
ConstraintToSize: (CGSize) maxSize
quy mô: (CGFloat) tỷ lệ
lệnh gọi lại: (GMSPlacePhotoImageResultCallback) lệnh gọi lại

Tải hình ảnh cho một ảnh cụ thể, được điều chỉnh theo tỷ lệ để vừa với kích thước tối đa đã cho.

Hình ảnh sẽ được chia tỷ lệ để vừa với kích thước đã cho trong khi vẫn duy trì tỷ lệ khung hình của hình ảnh gốc. Việc điều chỉnh tỷ lệ này được thực hiện ở phía máy chủ.

Nếu tham số tỷ lệ không phải là 1,0 maxSize sẽ được nhân với giá trị này và UIImage trả về sẽ được đặt để có tỷ lệ đã chỉ định. Bạn phải đặt tham số này thành tỷ lệ màn hình nếu đang tải hình ảnh để hiển thị trên màn hình.

SDK có thể lưu dữ liệu hình ảnh vào bộ nhớ đệm. Nếu ảnh được yêu cầu không tồn tại trong bộ nhớ đệm thì hoạt động tra cứu mạng sẽ được thực hiện.

Lưu ý:
Sau khi áp dụng hệ số tỷ lệ, các kích thước trong maxSize sẽ được làm tròn lên số nguyên gần nhất trước khi sử dụng. Nếu hình ảnh được yêu cầu lớn hơn kích thước tối đa hiện có, hệ thống có thể trả lại hình ảnh nhỏ hơn.
Các tham số:
photoMetadataGMSPlacePhotoMetadata để tải một UIImage.
maxSizeKích thước tối đa của hình ảnh.
quy môTỷ lệ để tải hình ảnh.
số gọi lạiLệnh callback để gọi bằng UIImage đã tải.
– (vô hiệu) currentPlaceWithCallback: (GMSPlaceLikelihoodListCallback) lệnh gọi lại

Trả về thông tin ước tính về địa điểm hiện đã xác định được vị trí của thiết bị.

Tạo danh sách khả năng của địa điểm dựa trên vị trí ước đoán gần đây nhất của thiết bị. Lệnh gọi lại đã cung cấp sẽ được gọi với danh sách khả năng này khi thành công và NSError khi xảy ra lỗi.

Lưu ý:
Phương thức này yêu cầu ứng dụng của bạn có quyền truy cập vào thông tin vị trí hiện tại của thiết bị. Trước khi gọi, hãy đảm bảo rằng bạn yêu cầu quyền truy cập vào vị trí của người dùng bằng [CLLocationManager requestWhenInUseAuthorize] hoặc [CLLocationManager requestAlways Buyers]. Nếu bạn gọi phương thức này nhưng ứng dụng của bạn không có trạng thái uỷ quyền chính xác, thì hệ thống sẽ gọi lại và báo lỗi.
Các tham số:
số gọi lạiLệnh gọi lại để gọi bằng danh sách khả năng của địa điểm.
- (vô hiệu) findAutofillFirebaseionsFromQuery: (NSString *) truy vấn
bộ lọc: (GMSAutocompleteFilter) có thể chứa giá trị rỗng *) bộ lọc
sessionToken: (GMSAutocompleteSessionToken có giá trị rỗng *) sessionToken
lệnh gọi lại: (GMSAutocompletePredictionsCallback) lệnh gọi lại

Tìm các cụm từ gợi ý của tính năng Tự động hoàn thành trong cụm từ tìm kiếm.

Kết quả có thể tuỳ ý thiên về một vị trí nhất định hoặc bị giới hạn ở một khu vực. Phương thức này không chặn.

Lệnh gọi lại đã cung cấp sẽ được gọi cùng với một loạt các dự đoán tự động hoàn thành khi thành công và NSError khi xảy ra lỗi.

Các tham số:
queryVăn bản một phần để tự động hoàn thành.
filterBộ lọc để áp dụng cho kết quả. Tham số này có thể bằng không.
sessionTokenGMSAutocompleteSessionToken để liên kết yêu cầu với một phiên thanh toán.
số gọi lạiLệnh gọi lại để gọi ra các dự đoán.
- (vô hiệu) retrievePlaceFromPlaceID: (NSString *) placeID
placeField: (GMSPlaceField) placeFields
sessionToken: (GMSAutocompleteSessionToken có giá trị rỗng *) sessionToken
lệnh gọi lại: (GMSPlaceResultCallback) lệnh gọi lại

Tìm nạp thông tin chi tiết cho một địa điểm.

Phương thức này không chặn.

Các tham số:
placeIDMã địa điểm cần tra cứu.
placeFieldsCác trường địa điểm riêng lẻ được yêu cầu cho các đối tượng địa điểm trong danh sách.
sessionTokenGMSAutocompleteSessionToken để liên kết yêu cầu với một phiên thanh toán.
số gọi lạiLệnh gọi lại để gọi kết quả tra cứu.
- (vô hiệu) findPlaceLikelihoodsFromCurrentLocationWithPlaceFields: (GMSPlaceField) placeFields
lệnh gọi lại: (GMSPlaceLikelihoodsCallback) lệnh gọi lại

Tìm khả năng xuất hiện của địa điểm bằng cách sử dụng vị trí hiện tại của người dùng.

Phương thức này không chặn.

Lệnh gọi lại đã cung cấp sẽ được gọi bằng một loạt các địa điểm có điểm số khả năng khi thành công và NSError khi xảy ra lỗi.

Các tham số:
placeFieldsCác trường địa điểm riêng lẻ được yêu cầu cho các đối tượng địa điểm trong danh sách.
số gọi lạiLệnh gọi lại để gọi các khả năng về địa điểm.
- (vô hiệu) isOpenWithPlaceID: (NSString *) placeID
lệnh gọi lại: (GMSPlaceOpenStatusCallback) lệnh gọi lại

Lấy thông tin chi tiết về một địa điểm, bao gồm tất cả các trường cần thiết để xác định GMSPlaceOpenStatus ở thời điểm hiện tại.

Phương thức này không chặn.

Các tham số:
placeIDMã địa điểm cần tra cứu.
số gọi lạiLệnh gọi lại để gọi kết quả về địa điểm.
- (vô hiệu) isOpenWithPlaceID: (NSString *) placeID
ngày: (NSDate *) date
lệnh gọi lại: (GMSPlaceOpenStatusCallback) lệnh gọi lại

Lấy thông tin chi tiết về một địa điểm, bao gồm tất cả các trường cần thiết để xác định GMSPlaceOpenStatus tại NSDate được chỉ định.

Phương thức này không chặn.

Các tham số:
placeIDMã địa điểm cần tra cứu.
dateNSDate để xác định trạng thái mở cửa.
số gọi lạiLệnh gọi lại để gọi kết quả về địa điểm.
- (vô hiệu) isOpenWithPlace: (GMSPlace *) địa điểm
lệnh gọi lại: (GMSPlaceOpenStatusCallback) lệnh gọi lại

Lấy thông tin chi tiết về một địa điểm, bao gồm tất cả các trường cần thiết để xác định GMSPlaceOpenStatus ở thời điểm hiện tại.

Chỉ yêu cầu các trường bổ sung nếu GMSPlace không có tất cả các trường cần thiết, nếu không, GMSPlaceOpenStatus sẽ được trả về ngay lập tức trong lệnh gọi lại. Phương thức này không chặn.

Các tham số:
địa điểmGMSPlace cần tra cứu.
số gọi lạiLệnh gọi lại để gọi kết quả về địa điểm.
- (vô hiệu) isOpenWithPlace: (GMSPlace *) địa điểm
ngày: (NSDate *) date
lệnh gọi lại: (GMSPlaceOpenStatusCallback) lệnh gọi lại

Lấy thông tin chi tiết về một địa điểm, bao gồm tất cả các trường cần thiết để xác định GMSPlaceOpenStatus tại NSDate được chỉ định.

Chỉ yêu cầu các trường bổ sung nếu GMSPlace không có tất cả các trường cần thiết, nếu không, 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 *_Kết quả có thể có giá trị rỗng, NSError *_Nullable error)) [related]

Loại lệnh gọi lại để nhận thông tin tra cứu thông tin chi tiết về địa điểm.

Nếu xảy ra lỗi, result sẽ giá trị bằng không và error sẽ chứa thông tin về lỗi.

Các tham số:
kết quảGMSPlace được trả về.
errorLỗi đã xảy ra, nếu có.
– (typedef void(^ GMSPlaceLikelihoodListCallback)(GMSPlaceLikelihoodList *_NullableabilitiesList, NSError *_Nullable error)) [related]

Loại lệnh gọi lại để nhận danh sách khả năng của địa điểm.

Nếu xảy ra lỗi, likelihoodList sẽ giá trị bằng không và error sẽ chứa thông tin về lỗi.

Các tham số:
likelihoodListDanh sách các khả năng của địa điểm.
errorLỗi đã xảy ra, nếu có.
– (typedef void(^ GMSPlaceLikelihoodsCallback)(NSArray< GMSPlaceLikelihood * > *_Nullable khả năng, NSError *_Nullable error)) [related]

Loại lệnh gọi lại để nhận mảng GMSPlaceLikelihood.

Nếu xảy ra lỗi, mảng sẽ có giá trị bằng không và error sẽ chứa thông tin về lỗi.

– (typedef void(^ GMSAutocompletePredictionsCallback)(NSArray< GMSAutocompletePrediction * > *_Nullable kết quả, NSError *_Nullable error)) [related]

Loại lệnh gọi lại để nhận kết quả tự động hoàn thành.

results là một mảng GMSAutofill Predictionions thể hiện việc hoàn thành đề xuất của truy vấn.

Các tham số:
kết quảMột mảng GMSAutocompletePrediction.
errorLỗi đã xảy ra, nếu có.
– (typedef void(^ GMSPlacePhotoMetadataResultCallback)(GMSPlacePhotoMetadataList *_Nullable ảnh, NSError *_Nullable error)) [related]

Loại lệnh gọi lại để nhận kết quả hình ảnh địa điểm.

Nếu xảy ra lỗi, photos sẽ giá trị bằng không và error sẽ chứa thông tin về lỗi.

Các tham số:
ảnhKết quả chứa đối tượng GMSPlacePhotoMetadata.
errorLỗi đã xảy ra, nếu có.
– (typedef void(^ GMSPlacePhotoImageResultCallback)(UIImage *_Nullable ảnh, NSError *_Nullable error)) [related]

Loại lệnh gọi lại để nhận các đối tượng UIImage từ đối tượng GMSPlacePhotoMetadata.

Nếu xảy ra lỗi, photo sẽ giá trị bằng không và error sẽ chứa thông tin về lỗi.

Các tham số:
ảnhUIImage đã được tải.
errorLỗi đã xảy ra, nếu có.
– (typedef void(^ GMSPlaceOpenStatusCallback)(kết quả GMSPlaceOpenStatus, NSError *_Nullable error)) [related]

Loại lệnh gọi lại để nhận trạng thái giờ mở cửa cho Địa điểm.

Nếu xảy ra lỗi, result sẽ là GMSPlaceOpenStatusUnknown và error sẽ chứa thông tin về lỗi.

Các tham số:
kết quảGMSPlaceOpenStatus được trả về.
errorLỗi đã xảy ra, nếu có.