Referência da classe GMSPlacesClient

Funções membro público | Funções membro públicas estáticas | Funções relacionadas

Referência da classe GMSPlacesClient

---

Visão geral

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 outro thread 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úblicas
(void)	— lookUpPlaceID:callback:
	Confira os detalhes de um lugar.
(void)	– fetchAutocompleteSuggestionsFromRequest:callback:
	Encontrar sugestões de preenchimento automático na consulta de texto.
(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, redimensionada para se ajustar às dimensões máximas especificadas.
(void)	currentPlaceWithCallback:
	Retorna uma estimativa do lugar em que o dispositivo está localizado no momento.
(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 lugar, incluindo todos os campos necessários para determinar o GMSPlaceOpenStatus no horário atual.
(void)	- isOpenWithPlaceID:date:callback:
	Recebe detalhes de um lugar, incluindo todos os campos necessários para determinar GMSPlaceOpenStatus no NSDate especificado.
(void)	isOpenWithPlace:callback:
	Recebe detalhes de um lugar, incluindo todos os campos necessários para determinar o GMSPlaceOpenStatus no horário atual.
(void)	isOpenWithPlace:date:callback:
	Recebe detalhes de um lugar, incluindo todos os campos necessários para determinar GMSPlaceOpenStatus no NSDate especificado.
(void)	— searchByTextWithRequest:callback:
	Pesquise lugares por texto e restrições.
(void)	fetchPlaceWithRequest:callback:
	Encontre um local usando um objeto de solicitação.
(void)	– fetchPhotoWithRequest:callback:
	Solicite uma foto usando a solicitação de busca de foto.
(void)	– searchNearbyWithRequest:callback:
	Pesquise lugares perto de uma restrição e um local.
Funções membro públicas estáticas
(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 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 desta versão do SDK do Google Places para iOS.
Funções relacionadas
Observe que 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 *_NullableibilityList, NSError *_Nullable error)
	Tipo de callback para receber listas de probabilidade de lugares.
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 do 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.
typedef void(^	GMSPlaceSearchByTextResultCallback )(NSArray< GMSPlace * > *_Nullable places, NSError *_Nullable error)
	Tipo de callback para receber resultados da pesquisa por texto.
typedef void(^	GMSFetchPhotoResultCallback )(UIImage *_Nullable photoImage, NSError *_Nullable error)
	Tipo de callback para receber uma foto.
typedef void(^	GMSAutocompleteSuggestionsCallback )(NSArray< GMSAutocompleteSuggestion * > *_Nullable results, NSError *_Nullable error)
	Tipo de callback para resultados de preenchimento automático.
typedef void(^	GMSPlaceSearchNearbyResultCallback )(NSArray< GMSPlace * > *_Nullable places, NSError *_Nullable error)
	Tipo de callback para receber resultados de pesquisa nas proximidades.

---

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 querer reter esse objeto diretamente, caso contrário, sua conexão com o Google pode ser reiniciada regularmente.

+ (BOOL) provideAPIKey:

(NSString *)

Chave

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á-la. Isto deve ser chamado por seu aplicativo antes de usar GMSPlacesClient (por exemplo, in application:didFinishLaunchingWithOptions:).

Retorna:

YES se a APIKey foi fornecida.

+ (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 ser disponibilizadas no seu aplicativo.

+ (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 desta versão do SDK do Google Places para iOS.

. Por exemplo, "1.0.0 (102.1)".

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

Confira os detalhes de um lugar.

Esse método não bloqueia.

Parâmetros:

placeID	O ID de lugar a ser pesquisado.
callback	O callback a ser invocado com o resultado da pesquisa.

Observação:

Esse recurso foi descontinuado. Este método foi substituído por fetchPlaceWithRequest:callback: e será removido em uma versão futura.

- (void) fetchAutocompleteSuggestionsFromRequest:		(GMSAutocompleteRequest *)	solicitação
callback:		(GMSAutocompleteSuggestionsCallback).	callback

Encontrar sugestões de preenchimento automático na consulta de texto.

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

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

Parâmetros:

request	A solicitação GMSAutocompleteRequest para preenchimento automático.
callback	O callback a ser invocado com as sugestões.

- (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, é necessário 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. São retornadas no máximo 10 fotos.

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.

Este método realiza uma pesquisa de rede.

Parâmetros:

placeID	O ID de lugar para procurar fotos.
callback	O 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.

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

Parâmetros:

photoMetadata	O GMSPlacePhotoMetadata em que um UIImage será carregado.
callback	O 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, redimensionada para se ajustar às dimensões máximas especificadas.

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 com a escala especificada. Esse parâmetro deverá ser definido como a escala da tela se você estiver carregando imagens para exibição na tela.

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

Observação:

Depois de aplicar o fator de escala, 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 do que o tamanho máximo disponível, uma imagem menor poderá ser retornada.

Parâmetros:

photoMetadata	O GMSPlacePhotoMetadata em que um UIImage será carregado.
maxSize	O tamanho máximo da imagem.
escalonar	A escala em que a imagem será carregada.
callback	O callback a ser invocado com o UIImage carregado.

- (void) currentPlaceWithCallback:

(GMSPlaceLikelihoodListCallback).

callback

Retorna uma estimativa do lugar em que o dispositivo está localizado no momento.

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:

Esse método exige que seu app tenha permissão para acessar a localização atual do dispositivo. Antes de chamar isso, lembre-se de solicitar 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:

callback

O callback a ser invocado com a lista de probabilidade de locais.

- (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 a um determinado local ou restritos a uma área. Esse método não bloqueia.

O retorno de chamada fornecido será invocado com uma matriz de previsões de preenchimento automático após a conclusão e um NSError quando houver um erro.

Parâmetros:

consulta	O texto parcial para preenchimento automático.
filtro	O filtro a ser aplicado aos resultados. Esse parâmetro pode ser nulo.
sessionToken	O GMSAutocompleteSessionToken para associar a solicitação a uma sessão de faturamento.
callback	O 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 bloqueia.

Parâmetros:

placeID	O ID de lugar a ser pesquisado.
placeFields	Os campos de local individuais solicitados para os objetos de local na lista.
sessionToken	O GMSAutocompleteSessionToken para associar a solicitação a uma sessão de faturamento.
callback	O callback a ser invocado com o resultado da pesquisa.

Observação:

Esse recurso foi descontinuado. Este método foi substituído por fetchPlaceWithRequest:callback: callback: e será removido em uma versão futura.

- (void) findPlaceLikelihoodsFromCurrentLocationWithPlaceFields:		(GMSPlaceField).	placeFields
callback:		(GMSPlaceLikelihoodsCallback).	callback

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

Esse método não bloqueia.

O callback fornecido será invocado com uma matriz de locais com pontuações de probabilidade se a operação for bem-sucedida e um NSError quando houver um erro.

Parâmetros:

placeFields	Os campos de local individuais solicitados para os objetos de local na lista.
callback	O callback a ser invocado com probabilidades de lugar.

- (void) isOpenWithPlaceID:		(NSString *)	placeID
callback:		(GMSPlaceOpenStatusCallback).	callback

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

Esse método não bloqueia.

Parâmetros:

placeID	O ID de lugar a ser pesquisado.
callback	O callback a ser invocado com o resultado de lugar.

- (void) isOpenWithPlaceID:		(NSString *)	placeID
data:		(NSDate *)	date
callback:		(GMSPlaceOpenStatusCallback).	callback

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

Esse método não bloqueia.

Parâmetros:

placeID	O ID de lugar a ser pesquisado.
date	O NSDate para determinar o status aberto.
callback	O callback a ser invocado com o resultado de lugar.

- (void) isOpenWithPlace:		(GMSPlace *)	lugar
callback:		(GMSPlaceOpenStatusCallback).	callback

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

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

Parâmetros:

lugar	O GMSPlace a ser pesquisado.
callback	O callback a ser invocado com o resultado de lugar.

- (void) isOpenWithPlace:		(GMSPlace *)	lugar
data:		(NSDate *)	date
callback:		(GMSPlaceOpenStatusCallback).	callback

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

Solicita campos adicionais apenas 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:

place	The GMSPlace to lookup.
date	The NSDate to determine open status for.
callback	The callback to invoke with the place result.

- (void) searchByTextWithRequest:		(GMSPlaceSearchByTextRequest *)	textSearchRequest
callback:		(GMSPlaceSearchByTextResultCallback).	callback

Pesquise lugares por texto e restrições.

Esse método não bloqueia.

Parâmetros:

textSearchRequest	GMSPlaceSearchByTextRequest: a solicitação de texto a ser usada na consulta.
callback	O callback a ser invocado com o resultado da pesquisa.

- (void) fetchPlaceWithRequest:		(GMSFetchPlaceRequest *)	fetchPlaceRequest
callback:		(GMSPlaceResultCallback).	callback

Encontre um local usando um objeto de solicitação.

Esse método não bloqueia.

Parâmetros:

fetchPlaceRequest	GMSFetchPlaceRequest: a solicitação de busca de lugar a ser usada na consulta.
callback	O callback a ser invocado com o resultado de lugar.

- (void) fetchPhotoWithRequest:		(GMSFetchPhotoRequest *)	fetchPhotoRequest
callback:		(GMSFetchPhotoResultCallback).	callback

Solicite uma foto usando a solicitação de busca de foto.

Esse método não bloqueia.

Parâmetros:

fetchPhotoRequest	GMSFetchPhotoRequest A solicitação de foto a ser usada.
callback	O callback a ser invocado com o resultado NSURL.

- (void) searchNearbyWithRequest:		(GMSPlaceSearchNearbyRequest *).	searchNearbyRequest
callback:		(GMSPlaceSearchNearbyResultCallback).	callback

Pesquise lugares perto de uma restrição e um local.

Esse método não bloqueia.

Parâmetros:

searchNearbyRequest	GMSPlaceSearchNearbyRequest: a solicitação de pesquisa nas proximidades que será usada na consulta.
callback	O callback a ser invocado com o resultado da pesquisa.

---

Documentação de funções de amigos e relacionadas

- (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 vai conter informações sobre o erro.

Parâmetros:

resultado	O GMSPlace que foi retornado.
error	O erro que ocorreu, se houver.

- (typedef void(^ GMSPlaceLikelihoodListCallback)(GMSPlaceLikelihoodList *_NullableibilityList, NSError *_Nullable error)) [related]

Tipo de callback para receber listas de probabilidade de lugares.

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

Parâmetros:

likelihoodList	A lista de probabilidades de lugares.
error	O 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 vai conter informações sobre o erro.

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

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

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

Parâmetros:

resultados	Uma matriz de GMSAutocompletePredictions.
error	O 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 vai conter informações sobre o erro.

Parâmetros:

fotos	O resultado que contém objetos GMSPlacePhotoMetadata.
error	O 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 vai conter informações sobre o erro.

Parâmetros:

foto	O UIImage que foi carregado.
error	O erro que ocorreu, se houver.

- (typedef void(^ GMSPlaceOpenStatusCallback)(resultado GMSPlaceOpenStatus, NSError *_Nullable)) [related]

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

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

Parâmetros:

resultado	O GMSPlaceOpenStatus que foi retornado.
error	O erro que ocorreu, se houver.

- (typedef void(^ GMSPlaceSearchByTextResultCallback)(NSArray< GMSPlace * > *_Nullable places, NSError *_Nullable error)) [related]

Tipo de callback para receber resultados da pesquisa por texto.

results é uma matriz de GMSPlace que representa resultados individuais que correspondem à consulta.

Parâmetros:

resultados	Uma matriz de GMSPlaces.
error	O erro que ocorreu, se houver.

- (typedef void(^ GMSFetchPhotoResultCallback)(UIImage *_Nullable photoImage, NSError *_Nullable error)) [related]

Tipo de callback para receber uma foto.

photoImage é um UIImage que representa a foto resultante que corresponde à solicitação especificada. Se ocorrer um erro, photoImage será nulo e error vai conter informações sobre o erro.

Parâmetros:

photoImage

Um resultado UIImage.

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

Tipo de callback para resultados de preenchimento automático.

Parâmetros:

resultados	Uma matriz de GMSAutocompleteSuggestion.
error	O erro que ocorreu, se houver.

- (typedef void(^ GMSPlaceSearchNearbyResultCallback)(NSArray< GMSPlace * > *_Nullable places, NSError *_Nullable error)) [related]

Tipo de callback para receber resultados de pesquisa nas proximidades.

Parâmetros:

lugares	Uma matriz de GMSPlace
error	O erro que ocorreu, se houver.