Referência da classe GMSPlacesClient

Funções membro públicas | 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 ver detalhes sobre lugares. Esta 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 de outra linha de execução resultará em uma exceção ou em 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
(nulo)	- lookUpPlaceID:callback:
	Consultar detalhes de um lugar.
(nulo)	- fetchAutocompleteSuggestionsFromRequest:callback:
	Encontre sugestões de preenchimento automático na consulta de texto.
(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:constrainedToSize: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 local em que o dispositivo está atualmente localizado.
(nulo)	— findAutocompletePredictionsFromQuery:filter:sessionToken:callback:
	Encontre previsões de preenchimento automático na consulta de texto.
(nulo)	— fetchPlaceFromPlaceID:placeFields:sessionToken:callback:
	Buscar detalhes de um lugar.
(nulo)	— findPlaceLikelihoodsFromCurrentLocationWithPlaceFields:callback:
	Encontre as probabilidades de lugares usando a localização atual do usuário.
(nulo)	— isOpenWithRequest:callback:
	Recebe o status aberto de um lugar.
(nulo)	- isOpenWithPlaceID:callback:
	Recebe detalhes de um lugar, incluindo todos os campos necessários para determinar o GMSPlaceOpenStatus no momento atual.
(nulo)	isOpenWithPlaceID:date:callback:
	Recebe detalhes de um lugar, incluindo todos os campos necessários para determinar GMSPlaceOpenStatus no NSDate especificado.
(nulo)	- isOpenWithPlace:callback:
	Recebe detalhes de um lugar, incluindo todos os campos necessários para determinar o GMSPlaceOpenStatus no momento atual.
(nulo)	isOpenWithPlace:date:callback:
	Recebe detalhes de um lugar, incluindo todos os campos necessários para determinar GMSPlaceOpenStatus no NSDate especificado.
(nulo)	— searchByTextWithRequest:callback:
	Pesquise lugares por texto e restrições.
(nulo)	- fetchPlaceWithRequest:callback:
	Consiga um local usando um objeto de solicitação.
(nulo)	— fetchPhotoWithRequest:callback:
	Solicite uma foto usando a solicitação de buscar foto.
(nulo)	— searchNearbyWithRequest:callback:
	Pesquise lugares próximos a um local e uma restrição.
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-o, se necessário.
(BOOL)	+ fornecerAPIKey:
	Fornece sua chave de API ao SDK do Google Places para iOS.
(NSString *)	+ openSourceLicenseInfo
	Retorna as informações de 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 dessa 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 *_NullableTipList, NSError *_Nullable error)
	Tipo de callback para receber listas de probabilidade de lugares.
typedef void(^	GMSPlaceLikelihoodsCallback )(NSArray< GMSPlaceLikelihood * > *_Nullable previsões, 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 os 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)(foto da UIImage *_Nullable, NSError *_Nullable error)
	Tipo de callback para receber objetos UIImage de um objeto GMSPlacePhotoMetadata.
typedef void(^	GMSPlaceOpenStatusCallback)(resultado de GMSPlaceOpenStatus, erro NSError *_Nullable)
	Tipo de callback para receber o status do horário de funcionamento do lugar.
typedef void(^	GMSPlaceOpenStatusResponseCallback)(GMSPlaceIsOpenResponse *resposta, NSError *_Nullable error)
	Tipo de callback para receber a resposta de status aberto.
typedef void(^	GMSPlaceSearchByTextResultCallback )(NSArray< GMSPlace * > *_Nullable places, NSError *_Nullable error)
	Tipo de callback para receber resultados de pesquisa por texto.
typedef void(^	GMSFetchPhotoResultCallback)(UIImage *_Nullable photoImage, erro NSError *_Nullable)
	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 da pesquisa por perto.

---

Documentação da função membro

+ (instancetype) sharedClient

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

Se seu aplicativo usa frequentemente métodos de GMSPlacesClient, ele pode querer 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 ao SDK do Google Places para iOS.

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

Retorna:

YES se a APIKey tiver sido fornecida com sucesso.

+ (NSString *) openSourceLicenseInfo

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

, Por exemplo, "1.0.0".

+ (NSString *) SDKLongVersion

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

, Por exemplo, "1.0.0 (102.1)".

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

Consultar 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:

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

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

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

Os resultados podem ser direcionados a uma determinada localização 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 se a operação for bem-sucedida e um NSError se ocorrer um erro.

Parâmetros:

solicitação	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 vêm 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 as atribuições adicionais necessárias e exibir essas atribuições no 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 podem ter mudado.

Esse método executa uma pesquisa de rede.

Parâmetros:

placeID	O ID de local para o qual as fotos serão pesquisadas.
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 de imagens podem ser armazenados em cache pelo SDK. Se a foto solicitada não existir no cache, será realizada uma pesquisa de rede.

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
constrainedToSize:		(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á redimensionada para caber nas dimensões fornecidas, mantendo a proporção da imagem original. Esse escalonamento é realizado no lado do servidor.

Se o parâmetro de escalonamento 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 precisa ser definido como a escala da tela se você estiver carregando imagens para exibição na tela.

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

Observação:

Após 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 uma imagem maior que o tamanho máximo disponível for solicitada, 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 local em que o dispositivo está atualmente localizado.

Gera uma lista de probabilidade de lugares com base na última localização estimada do dispositivo. O callback fornecido será invocado com essa lista de probabilidades após a conclusão e um NSError se 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 fazer essa chamada, solicite acesso à localização do usuário utilizando [CLLocationManager requestWhenInUseAuthorization] ou [CLLocationManager requestSempreAuthorization]. 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 lugares.

- (void) findAutocompletePredictionsFromQuery:		(NSString *)	query
filtro:		(GMSAutocompleteFilter * anulável)	filter
sessionToken:		(GMSAutocompleteSessionToken * anulável)	sessionToken
callback:		(GMSAutocompletePredictionsCallback)	callback

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

Os resultados podem ser direcionados a uma determinada localização 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 se ocorrer um erro.

Parâmetros:

consulta	O texto parcial a ser preenchido automaticamente.
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 para invocar 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 lugar 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:

O uso foi descontinuado. Esse 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 as probabilidades de lugares usando a localização atual do usuário.

Esse método não bloqueia.

O retorno de chamada fornecido será invocado com uma matriz de locais com pontuações de probabilidade após a conclusão e um NSError se ocorrer um erro.

Parâmetros:

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

- (void) isOpenWithRequest:		(GMSPlaceIsOpenRequest *)	isOpenRequest
callback:		(GMSPlaceOpenStatusResponseCallback)	callback

Recebe o status aberto de um local, incluindo todas as propriedades necessárias para determinar GMSPlaceOpenStatus na NSDate especificada. Esse método não bloqueia.

Parâmetros:

isOpenRequest	A solicitação para determinar o status aberto de um determinado local.
callback	O callback a ser invocado com a resposta de status aberta.

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

Recebe o status aberto de um lugar, incluindo todos os campos necessários para determinar o GMSPlaceOpenStatus no momento 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 do lugar.

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

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

Esse método não bloqueia.

Parâmetros:

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

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

Recebe o status aberto de um lugar, incluindo todos os campos necessários para determinar o GMSPlaceOpenStatus no momento atual.

Só solicita campos adicionais se o GMSPlace não tiver todos os campos necessários. Caso contrário, GMSPlaceOpenStatus vai ser retornado 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 do lugar.

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

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

Só solicita campos adicionais se o 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

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

Esse método não bloqueia.

Parâmetros:

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

- (void) retrievePhotoWithRequest:		(GMSFetchPhotoRequest *)	fetchPhotoRequest
callback:		(GMSFetchPhotoResultCallback)	callback

Solicite uma foto usando a solicitação de buscar 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 próximos a um local e uma restrição.

Esse método não bloqueia.

Parâmetros:

searchNearbyRequest	GMSPlaceSearchNearbyRequest A solicitação "Pesquisar nas proximidades" a ser usada na consulta.
callback	O callback a ser invocado com o resultado da pesquisa.

---

Documentação de amigos e funções 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 conterá informações sobre o erro.

Parâmetros:

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

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

Tipo de callback para receber listas de probabilidade de lugares.

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

Parâmetros:

likelihoodList	A lista de probabilidades de lugares.
erro	O erro que ocorreu, se houver.

- (typedef void(^ GMSPlaceLikelihoodsCallback)(NSArray< GMSPlaceLikelihood * > *_Nullablecimentos, 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 os resultados do preenchimento automático.

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

Parâmetros:

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

Parâmetros:

fotos	O resultado contendo objetos GMSPlacePhotoMetadata.
erro	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 conterá informações sobre o erro.

Parâmetros:

foto	O UIImage que foi carregado.
erro	O 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:

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

- (typedef void(^ GMSPlaceOpenStatusResponseCallback)(GMSPlaceIsOpenResponse *response, NSError *_Nullable error)) [related]

Tipo de callback para receber a resposta de status aberto.

Se ocorrer um erro, a resposta terá o status GMSPlaceOpenStatusUnknown e o erro conterá informações sobre o erro.

Parâmetros:

resposta	O GMSPlaceIsOpenResponse que foi retornado.
erro	O erro que ocorreu, se houver.

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

Tipo de callback para receber resultados de pesquisa por texto.

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

Parâmetros:

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

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

Tipo de callback para receber uma foto.

photoImage é uma UIImage que representa a foto resultante que corresponde à solicitação especificada. Se ocorrer um erro, photoImage será nulo e error 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.
erro	O erro que ocorreu, se houver.

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

Tipo de callback para receber resultados da pesquisa por perto.

Parâmetros:

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