Referência da classe GMSPlacesClient


Visão geral

Interface principal do SDK do Places.

Usado para pesquisar e ver detalhes sobre lugares. Essa classe deve ser acessada pelo método [GMSPlacesClient sharedClient].

Os métodos GMSPlacesClient só devem ser chamados a partir do thread principal. Chamar esses métodos de outra linha de execução resultará em uma exceção ou um comportamento indefinido. A menos que especificado de outra forma, todos os retornos de chamada serão invocados na linha de execução principal.

Funções públicas de membros

(nulo)- lookUpPlaceID:callback:
 Ver detalhes de um lugar.
(nulo)- lookUpPhotosForPlaceID:callback:
 Recebe os metadados de até 10 fotos associadas a um lugar.
(nulo)- loadPlacePhoto:callback:
 Carrega a imagem de uma foto específica no tamanho máximo.
(nulo)- loadPlacePhoto:restrictedToSize:scale:callback:
 Carrega a imagem de uma foto específica, dimensionada para se ajustar às dimensões máximas fornecidas.
(nulo)- currentPlaceWithCallback:
 Retorna uma estimativa do lugar onde o dispositivo está localizado atualmente.
(nulo)- findAutocompletePredictionsFromQuery:filter:sessionToken:callback:
 Encontre previsões de preenchimento automático de consulta de texto.
(nulo)- fetchPlaceFromPlaceID:placeFields:sessionToken:callback:
 Buscar detalhes de um lugar.
(nulo)- findPlaceLikelihoodsFromCurrentLocationWithPlaceFields:callback:
 Encontre probabilidades de local usando a localização atual do usuário.

Funções estáticas de membros públicos

(instancetype)+ sharedClient.
 Fornece a instância compartilhada de GMSPlacesClient para o SDK do Google Places para iOS, criando-a se necessário.
(BOOL)+ provideAPIKey:
 Fornece sua chave de API para o SDK do Google Places para iOS.
(NSString *)+ openSourceLicenseInfo
 Retorna informações de licença de software de código aberto do SDK do Google Places para iOS.
(NSString *)+ SDKVersion
 Retorna a versão para esta versão do SDK do Google Places para iOS.
(NSString *)+ SDKLongVersion
 Retorna a versão longa desta versão do SDK do Google Places para iOS.

Essas funções não são membros.

typedef void(^ GMSPlaceResultCallback )(GMSPlace *_Nullable result, NSError *_Nullable error)
 Tipo de callback para receber pesquisas de detalhes de lugares.
typedef void(^ GMSPlaceLikelihoodListCallback )(GMSPlaceLikelihoodList *_Nullable likelihoodList, NSError *_Nullable error)
 Tipo de callback para receber listas de probabilidade de lugar.
typedef void(^ GMSPlaceLikelihoodsCallback )(NSArray< GMSPlaceLikelihood * > *_Probabilidades anuláveis, NSError *_Nullable error)
 Tipo de callback para receber uma matriz de GMSPlaceLikelihoods.
typedef void(^ GMSAutocompletePredictionsCallback )(NSArray< GMSAutocompletePrediction * * > *_Nullable results, NSError *_Nullable error)
 Tipo de callback para receber resultados de preenchimento automático.
typedef void(^ GMSPlacePhotoMetadataResultCallback )(GMSPlacePhotoMetadataList *_Nullable photos, NSError *_Nullable error)
 Tipo de callback para receber resultados de fotos de lugares.
typedef void(^ GMSPlacePhotoImageResultCallback)(UIImage *_nullable photo, NSError *_Nullable error)
 Tipo de callback para receber objetos UIImage de um objeto GMSPlacePhotoMetadata.

Documentação da função do membro

+ (tipo de instância) sharedClient

Fornece a instância compartilhada de GMSPlacesClient para o SDK do Google Places para iOS, criando-a se necessário.

Se seu aplicativo usa frequentemente métodos de GMSPlacesClient, convém manter esse objeto diretamente, caso contrário, sua conexão com o Google pode ser reiniciada regularmente.

+ (BOOL) provideAPIKey: (NSString *) key

Fornece sua chave de API para o SDK do Google Places para iOS.

Essa chave é gerada para seu aplicativo por meio do Console do Google Cloud Platform e é pareada com o ID do pacote do seu aplicativo para identificá-la. Isso deve ser chamado pelo aplicativo antes de usar GMSPlacesClient (por exemplo, em application:didFinishLaunchingWithOptions:).

Retorna:
SIM, se a chave de API foi fornecida.
+ (NSString *) openSourceLicenseInfo

Retorna informações de licença de software de código aberto do SDK do Google Places para iOS.

Essas informações precisam ser disponibilizadas no seu aplicativo.

+ (NSString *) SDKVersion

Retorna a versão para esta versão do SDK do Google Places para iOS.

. Por exemplo, "1.0.0".

+ (NSString *) SDKLongVersion

Retorna a versão longa desta versão do SDK do Google Places para iOS.

Por exemplo, "1.0.0 (102.1)".

- (void) lookUpPlaceID: (NSString *) ID do local
retorno de chamada: (GMSPlaceResultCallback). callback

Ver detalhes de um lugar.

Esse método não causa bloqueios.

Parâmetros:
ID de lugarO ID de lugar a ser pesquisado.
callbackO callback a ser invocado com o resultado da pesquisa.
- (void) lookUpPhotosForPlaceID: (NSString *) ID do local
retorno de chamada: (GMSPlacePhotoMetadataResultCallback). callback

Recebe os metadados de até 10 fotos associadas a um lugar.

As fotos são provenientes de vários locais, incluindo proprietários de empresas e fotos enviadas por usuários do Google+. Na maioria dos casos, essas fotos podem ser usadas sem atribuição ou terão a atribuição necessária incluída na imagem. No entanto, é necessário usar a propriedade attributions na resposta para recuperar quaisquer atribuições adicionais necessárias e exibir essas atribuições em seu aplicativo sempre que exibir a imagem. No máximo 10 fotos são retornadas.

Várias chamadas desse método provavelmente retornarão as mesmas fotos todas as vezes. No entanto, isso não é garantido, porque os dados subjacentes podem ter mudado.

Esse método executa uma pesquisa de rede.

Parâmetros:
ID de lugarO ID de local para o qual as fotos serão pesquisadas.
callbackO callback a ser invocado com o resultado da pesquisa.
- (nulo) loadPlacePhoto: (GMSPlacePhotoMetadata *) photoMetadata.
retorno de chamada: (GMSPlacePhotoImageResultCallback) callback

Carrega a imagem de uma foto específica no tamanho máximo.

Os dados da imagem podem ser armazenados em cache pelo SDK. Se a foto solicitada não existir no cache, será realizada uma pesquisa na rede.

Parâmetros:
metadados de fotoO GMSPlacePhotoMetadata para o qual carregar um UIImage.
callbackO callback a ser invocado com o UIImage carregado.
- (nulo) loadPlacePhoto: (GMSPlacePhotoMetadata *) photoMetadata.
restrictedToSize: (CGSize) maxSize (em inglês)
escala: (CGFloat) escalar
retorno de chamada: (GMSPlacePhotoImageResultCallback) callback

Carrega a imagem de uma foto específica, dimensionada para se ajustar às dimensões máximas fornecidas.

A imagem será redimensionada para se ajustar às dimensões especificadas, mantendo a proporção da imagem original. Esse escalonamento é realizado no lado do servidor.

Se o parâmetro de escala não for 1.0, maxSize será multiplicado por esse valor e o UIImage retornado será definido para ter a escala especificada. Esse parâmetro deve ser definido para a escala da tela se você estiver carregando imagens para exibição.

Os dados da imagem podem ser armazenados em cache pelo SDK. Se a foto solicitada não existir no cache, será realizada uma pesquisa na rede.

Observação:
Após aplicar o fator de escala, as dimensões em maxSize serão arredondadas para o número inteiro mais próximo antes de serem usadas. Se for solicitada uma imagem maior que o tamanho máximo disponível, uma imagem menor poderá ser retornada.
Parâmetros:
metadados de fotoO GMSPlacePhotoMetadata para o qual carregar um UIImage.
tamanho máximoO tamanho máximo da imagem.
escalonarA escala em que a imagem será carregada.
callbackO callback a ser invocado com o UIImage carregado.

Retorna uma estimativa do lugar onde o dispositivo está localizado atualmente.

Gera uma lista de probabilidade de lugar com base na última localização estimada do dispositivo. O retorno de chamada fornecido será invocado com esta lista de probabilidades após a conclusão e um NSError quando ocorrer um erro.

Observação:
Este método exige que o app tenha permissão para acessar a localização atual do dispositivo. Antes de chamar, certifique-se de solicitar acesso à localização dos usuários usando [CLLocationManager requestWhenInUseAuthorization] ou [CLLocationManager requestAlwaysAuthorization]. Se você chamar esse método e o app não tiver o status de autorização correto, o callback será chamado com um erro.
Parâmetros:
callbackO callback a ser invocado com a lista de probabilidade de lugar.
- (void) findAutocompletePredictionsFromQuery: (NSString *) query
filtro: (anulável GMSAutocompleteFilter *) filter
sessionToken: (GMSAutocompleteSessionToken * anulável) sessionToken (em inglês)
retorno de chamada: (GMSAutocompletePredictionsCallback) callback

Encontre previsões de preenchimento automático de consulta de texto.

Os resultados podem ser direcionados para um local específico ou restritos a uma área. Esse método não causa bloqueios.

O retorno de chamada fornecido será invocado com uma matriz de previsões de preenchimento automático em caso de êxito e um NSError em caso de erro.

Parâmetros:
consultaO texto parcial a ser preenchido automaticamente.
Função filterO filtro a ser aplicado aos resultados. Este parâmetro pode ser nulo.
token de sessãoO GMSAutocompleteSessionToken para associar a solicitação a uma sessão de faturamento.
callbackO callback a ser invocado com as previsões.
- (nulo) fetchPlaceFromPlaceID: (NSString *) ID do local
placeFields: (GMSPlaceField). placeFields.
sessionToken: (GMSAutocompleteSessionToken * anulável) sessionToken (em inglês)
retorno de chamada: (GMSPlaceResultCallback). callback

Buscar detalhes de um lugar.

Esse método não causa bloqueios.

Parâmetros:
ID de lugarO ID de lugar a ser pesquisado.
placeFieldsOs campos de local individuais solicitados para os objetos de local na lista.
token de sessãoO GMSAutocompleteSessionToken para associar a solicitação a uma sessão de faturamento.
callbackO callback a ser invocado com o resultado da pesquisa.
- (nulo) findPlaceLikelihoodsFromCurrentLocationWithPlaceFields: (GMSPlaceField). placeFields.
retorno de chamada: (GMSPlaceLikelihoodsCallback) callback

Encontre probabilidades de local usando a localização atual do usuário.

Esse método não causa bloqueios.

O retorno de chamada fornecido será invocado com uma matriz de locais com pontuações de probabilidade em caso de sucesso e um NSError em caso de erro.

Parâmetros:
placeFieldsOs campos de local individuais solicitados para os objetos de local na lista.
callbackO callback a ser invocado com probabilidades de local.

- (typedef void(^ GMSPlaceResultCallback)(GMSPlace *_resultado nulo, NSError *_Nullable error)) [related]

Tipo de callback para receber pesquisas de detalhes de lugares.

Se ocorrer um erro, result será nulo e error conterá informações sobre o erro.

Parâmetros:
resultadoO GMSPlace que foi retornado.
errorO erro que ocorreu, se houver.
- (typedef void(^ GMSPlaceLikelihoodListCallback)(GMSPlaceLikelihoodList *_Nullable likelihoodList, NSError *_Nullable error)) [related]

Tipo de callback para receber listas de probabilidade de lugar.

Se ocorrer um erro, likelihoodList será nulo e error conterá informações sobre o erro.

Parâmetros:
Lista de probabilidadesA lista de probabilidades de local.
errorO erro que ocorreu, se houver.
- (typedef void(^ GMSPlaceLikelihoodsCallback)(NSArray< GMSPlaceLikelihood * > *_Probabilidades anuláveis, NSError *_Nullable error)) [related]

Tipo de callback para receber uma matriz de GMSPlaceLikelihoods.

Se ocorrer um erro, a matriz será nula e error conterá informações sobre o erro.

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

Tipo de callback para receber resultados de preenchimento automático.

results é uma matriz de GMSAutocompletePredictions representando as conclusões candidatas da consulta.

Parâmetros:
resultadosUma matriz de GMSAutocompletePredictions.
errorO erro que ocorreu, se houver.
- (typedef void(^ GMSPlacePhotoMetadataResultCallback)(GMSPlacePhotoMetadataList *_Nullable photos, NSError *_Nullable error)) [related]

Tipo de callback para receber resultados de fotos de lugares.

Se ocorrer um erro, photos será nulo e error conterá informações sobre o erro.

Parâmetros:
fotosO resultado contendo objetos GMSPlacePhotoMetadata.
errorO erro que ocorreu, se houver.
- (typedef void(^ GMSPlacePhotoImageResultCallback)(UIImage *_Nullable photo, NSError *_Nullable error)) [related]

Tipo de callback para receber objetos UIImage de um objeto GMSPlacePhotoMetadata.

Se ocorrer um erro, photo será nulo e error conterá informações sobre o erro.

Parâmetros:
fotoO UIImage que foi carregado.
errorO erro que ocorreu, se houver.