Referência da classe GMSPlacesClient


Informações gerais

Interface principal do SDK do Places.

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

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

Funções membro público

(void) lookUpPlaceID:callback:
 Receber detalhes de um lugar.
(void) lookUpPhotosForPlaceID:callback:
 Recebe os metadados de até 10 fotos associadas a um lugar.
(void) loadPlacePhoto:callback:
 Carrega a imagem de uma foto específica no tamanho máximo.
(void) loadPlacePhoto:constrainedToSize:scale:callback:
 Carrega a imagem de uma foto específica, dimensionada para se ajustar às dimensões máximas fornecidas.
(void) currentPlaceWithCallback:
 Retorna uma estimativa do lugar em que o dispositivo está atualmente.
(void) findAutocompletePredictionsFromQuery:filter:sessionToken:callback:
 Encontrar previsões de preenchimento automático da consulta de texto.
(void) fetchPlaceFromPlaceID:placeFields:sessionToken:callback:
 Buscar detalhes de um lugar.
(void) findPlaceLikelihoodsFromCurrentLocationWithPlaceFields:callback:
 Encontre probabilidades de lugares usando a localização atual do usuário.
(void) isOpenWithPlaceID:callback:
 Recebe detalhes de um local, incluindo todos os campos necessários para determinar GMSPlaceOpenStatus no horário atual.
(void) isOpenWithPlaceID:date:callback:
 Recebe detalhes de um local, incluindo todos os campos necessários para determinar GMSPlaceOpenStatus no NSDate especificado.
(void) isOpenWithPlace:callback:
 Recebe detalhes de um local, incluindo todos os campos necessários para determinar GMSPlaceOpenStatus no horário atual.
(void) isOpenWithPlace:date:callback:
 Recebe detalhes de um local, incluindo todos os campos necessários para determinar GMSPlaceOpenStatus no NSDate especificado.

Funções membro públicas estáticas

(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.
(BOOL) + provideAPIKey:
 Fornece sua chave de API ao SDK do Google Places para iOS.
(NSString *)+ openSourceLicenseInfo
 Retorna as informações da licença de software de código aberto do SDK do Google Places para iOS.
(NSString *)+ SDKVersion
 Retorna a versão desta versão do SDK do Google Places para iOS.
(NSString *)+ SDKLongVersion
 Retorna a versão longa deste lançamento do SDK do Google Places para iOS.

Essas não são funções de membro.

typedef void(^ GMSPlaceResultCallback )(GMSPlace *_Nullable result, NSError *_Nullable error)
 Tipo de callback para receber pesquisas de detalhes do lugar.
typedef void(^ GMSPlaceLikelihoodListCallback )(GMSPlaceLikelihoodList *_NullabledensityList, NSError *_Nullable error)
 Tipo de callback para receber listas de probabilidade de lugar.
typedef void(^ GMSPlaceLikelihoodsCallback )(NSArray< GMSPlaceLikelihood * > *_Nullable probabilidades, NSError *_Nullable error)
 Tipo de callback para receber a 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.
typedef void(^ GMSPlaceOpenStatusCallback)(resultado GMSPlaceOpenStatus, NSError *_Nullable)
 Tipo de callback para receber o status do horário de funcionamento do lugar.

Documentação da função 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 métodos de GMSPlacesClient com frequência, pode ser necessário reter 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 ao SDK do Google Places para iOS.

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

Retorna:
YES se a APIKey foi fornecida com sucesso.
+ (NSString *) openSourceLicenseInfo

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

Essas informações precisam estar disponíveis na sua inscrição.

+ (NSString *) SDKVersion

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

Por exemplo, "1.0.0".

+ (NSString *) SDKLongVersion

Retorna a versão longa deste lançamento do SDK do Google Places para iOS.

Por exemplo, "1.0.0 (102.1)".

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

Receber detalhes de um lugar.

Esse método não faz bloqueios.

Parâmetros:
placeIDO ID de lugar a ser pesquisado.
callbackO callback a ser invocado com o resultado da pesquisa.
- (void) lookUpPhotosForPlaceID: (NSString *) placeID
callback: (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, é preciso usar a propriedade attributions na resposta para extrair as atribuições adicionais necessárias e mostrá-las no aplicativo sempre que você mostrar a imagem. Até 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 podem ter mudado.

Esse método realiza uma pesquisa de rede.

Parâmetros:
placeIDO ID de local para o qual procurar fotos.
callbackO callback a ser invocado com o resultado da pesquisa.
- (void) loadPlacePhoto: (GMSPlacePhotoMetadata *). photoMetadata
callback: (GMSPlacePhotoImageResultCallback) callback

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

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

Parâmetros:
photoMetadataO GMSPlacePhotoMetadata em que um UIImage será carregado.
callbackO callback a ser invocado com o UIImage carregado.
- (void) loadPlacePhoto: (GMSPlacePhotoMetadata *). photoMetadata
restrictedToSize: (CGSize) maxSize
escala: (CGFloat) escala
callback: (GMSPlacePhotoImageResultCallback) callback

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

A imagem será dimensionada para se ajustar às dimensões indicadas, 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 com a escala especificada. Esse parâmetro deverá ser definido para a escala da tela se você estiver carregando imagens para exibição na tela.

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

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

Retorna uma estimativa do lugar em que o dispositivo está atualmente.

Gera uma lista de probabilidade de lugares com base na última localização estimada do dispositivo. O retorno de chamada fornecido será invocado com essa lista de probabilidades em caso de sucesso e um NSError em caso de erro.

Observação:
Este método exige que o app tenha permissão para acessar a localização atual do dispositivo. Antes de chamar esta função, solicite acesso à localização do usuário 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: (GMSAutocompleteFilter * anulável) filter
sessionToken: (GMSAutocompleteSessionToken anulável *) sessionToken
callback: (GMSAutocompletePredictionsCallback) callback

Encontrar previsões de preenchimento automático da consulta de texto.

Os resultados podem ser direcionados para um determinado local ou restritos a uma área. Esse método não faz bloqueios.

O retorno de chamada fornecido será invocado com uma matriz de previsões de preenchimento automático em caso de sucesso 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. Esse parâmetro pode ser nulo.
sessionTokenO GMSAutocompleteSessionToken para associar a solicitação a uma sessão de faturamento.
callbackO callback a ser invocado com as previsões.
- (void) fetchPlaceFromPlaceID: (NSString *) placeID
placeFields: (GMSPlaceField). placeFields
sessionToken: (GMSAutocompleteSessionToken anulável *) sessionToken
callback: (GMSPlaceResultCallback) callback

Buscar detalhes de um lugar.

Esse método não faz bloqueios.

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

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

Esse método não faz 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.
- (void) isOpenWithPlaceID: (NSString *) placeID
callback: (GMSPlaceOpenStatusCallback) callback

Recebe detalhes de um local, incluindo todos os campos necessários para determinar GMSPlaceOpenStatus no horário atual.

Esse método não faz bloqueios.

Parâmetros:
placeIDO ID de lugar a ser pesquisado.
callbackO callback a ser invocado com o resultado do local.
- (void) isOpenWithPlaceID: (NSString *) placeID
data: (NSDate *) date
callback: (GMSPlaceOpenStatusCallback) callback

Recebe detalhes de um local, incluindo todos os campos necessários para determinar GMSPlaceOpenStatus no NSDate especificado.

Esse método não faz bloqueios.

Parâmetros:
placeIDO ID de lugar a ser pesquisado.
dataO NSDate para o qual determinar o status aberto.
callbackO callback a ser invocado com o resultado do local.
- (void) isOpenWithPlace: (GMSPlace *) lugar
callback: (GMSPlaceOpenStatusCallback) callback

Recebe detalhes de um local, incluindo todos os campos necessários para determinar GMSPlaceOpenStatus no horário atual.

Solicita campos adicionais apenas se GMSPlace não tiver todos os campos necessários. Caso contrário, GMSPlaceOpenStatus será retornado no callback imediatamente. Esse método não faz bloqueios.

Parâmetros:
lugarO GMSPlace a ser pesquisado.
callbackO callback a ser invocado com o resultado do local.
- (void) isOpenWithPlace: (GMSPlace *) lugar
data: (NSDate *) date
callback: (GMSPlaceOpenStatusCallback) callback

Recebe detalhes de um local, incluindo todos os campos necessários para determinar GMSPlaceOpenStatus no NSDate especificado.

Solicita campos adicionais somente se GMSPlace não tiver todos os campos necessários. Caso contrário, 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 result, NSError *_Nullable error)) [related]

Tipo de callback para receber pesquisas de detalhes do lugar.

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 *_NullablePromptList, 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:
likelihoodListA lista de probabilidades de lugares.
errorO erro que ocorreu, se houver.
- (typedef void(^ GMSPlaceLikelihoodsCallback)(NSArray< GMSPlaceLikelihood * > *_Nullable probabilidades, NSError *_Nullable error)) [related]

Tipo de callback para receber a 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 que representa 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.
- (typedef void(^ GMSPlaceOpenStatusCallback)(resultado GMSPlaceOpenStatus, NSError *_Nullable error)) [related]

Tipo de callback para receber o status do horário de funcionamento do lugar.

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

Parâmetros:
resultadoO GMSPlaceOpenStatus que foi retornado.
errorO erro que ocorreu, se houver.