MapsSearchClient class
Classe de cliente para interagir com o Serviço de Pesquisa do Azure Mapas.
Construtores
| Maps |
Cria uma instância do MapsSearchClient a partir de uma chave de assinatura. Exemplo |
| Maps |
Cria uma instância de MapsSearchClient a partir de uma identidade Exemplo |
Métodos
| begin |
Envia lotes de solicitações de pesquisa difusas. O método retorna um poller para recuperar o resultado posteriormente. |
| begin |
Envia lotes de solicitações de geocodificação reversa. O método retorna um poller para recuperar o resultado posteriormente. |
| begin |
Envia lotes de solicitações de geocodificação. O método retorna um poller para recuperar o resultado posteriormente. |
| fuzzy |
Executa uma pesquisa de forma livre que lida com as entradas mais difusas, lidando com qualquer combinação de endereços ou tokens de POI. |
| get |
Solicita os dados de geometria, como um contorno de cidade ou país para um conjunto de entidades. |
| get |
Solicita uma lista completa das categorias de Pontos de Interesse (POI) suportadas. |
| resume |
Continue a solicitação de pesquisa difusa com um estado serializado de outro poller. Exemplo |
| resume |
Continue a solicitação de pesquisa de endereço inverso com um estado serializado de outro poller. Exemplo |
| resume |
Continue a solicitação de pesquisa de endereço com um estado serializado de outro poller. Exemplo |
| reverse |
Traduz uma coordenada em um endereço compreensível para humanos. |
| reverse |
Traduz uma coordenada em uma rua transversal compreensível por humanos. |
| search |
Geocodifica um endereço. |
| search |
Executa uma pesquisa difusa de POIs ao longo de uma rota especificada. |
| search |
Executa uma pesquisa de forma livre dentro de uma única geometria ou de muitas delas. |
| search |
Solicita resultados de pontos de interesse (POI) em torno de um local específico. |
| search |
Solicita resultados de pontos de interesse (POI) por nome |
| search |
Solicita resultados de pontos de interesse (POI) de determinada categoria. |
| search |
Geocodifica um endereço estruturado. |
Detalhes do construtor
MapsSearchClient(AzureKeyCredential, MapsSearchClientOptions)
Cria uma instância do MapsSearchClient a partir de uma chave de assinatura.
Exemplo
import { MapsSearchClient, AzureKeyCredential } from "@azure/maps-search";
const credential = new AzureKeyCredential("<subscription-key>");
const client = new MapsSearchClient(credential);
new MapsSearchClient(credential: AzureKeyCredential, options?: MapsSearchClientOptions)Parâmetros
- credential
- AzureKeyCredential
Uma instância do AzureKeyCredential usada para autenticar solicitações para o serviço
- options
- MapsSearchClientOptions
Opções usadas para configurar o Cliente de Pesquisa
MapsSearchClient(TokenCredential, string, MapsSearchClientOptions)
Cria uma instância de MapsSearchClient a partir de uma identidade TokenCredentialdo Azure.
Exemplo
import { MapsSearchClient } from "@azure/maps-search";
import { DefaultAzureCredential } from "@azure/identity";
const credential = new DefaultAzureCredential();
const client = new MapsSearchClient(credential, "<maps-account-client-id>");
new MapsSearchClient(credential: TokenCredential, mapsAccountClientId: string, options?: MapsSearchClientOptions)Parâmetros
- credential
- TokenCredential
Uma instância tokenCredential usada para autenticar solicitações para o serviço
- mapsAccountClientId
-
string
A ID do cliente do Azure Mapas de um recurso de mapa específico
- options
- MapsSearchClientOptions
Opções usadas para configurar o Cliente de Pesquisa
Detalhes do método
beginFuzzySearchBatch(FuzzySearchRequest[], FuzzySearchBatchOptions)
Envia lotes de solicitações de pesquisa difusas. O método retorna um poller para recuperar o resultado posteriormente.
function beginFuzzySearchBatch(requests: FuzzySearchRequest[], options?: FuzzySearchBatchOptions): Promise<FuzzySearchBatchPoller>Parâmetros
- requests
A matriz de solicitações de pesquisa a serem processadas. A matriz pode conter um máximo de 10.000 solicitações e deve conter pelo menos 1 solicitação.
- options
- FuzzySearchBatchOptions
Parâmetros opcionais para a operação
Retornos
Promise<FuzzySearchBatchPoller>
beginReverseSearchAddressBatch(ReverseSearchAddressRequest[], ReverseSearchAddressBatchOptions)
Envia lotes de solicitações de geocodificação reversa. O método retorna um poller para recuperar o resultado posteriormente.
function beginReverseSearchAddressBatch(requests: ReverseSearchAddressRequest[], options?: ReverseSearchAddressBatchOptions): Promise<ReverseSearchAddressBatchPoller>Parâmetros
- requests
A matriz de solicitações de pesquisa a serem processadas. A matriz pode conter um máximo de 10.000 solicitações e deve conter pelo menos 1 solicitação.
- options
- ReverseSearchAddressBatchOptions
Parâmetros opcionais para a operação
Retornos
Promise<ReverseSearchAddressBatchPoller>
beginSearchAddressBatch(SearchAddressRequest[], SearchAddressBatchOptions)
Envia lotes de solicitações de geocodificação. O método retorna um poller para recuperar o resultado posteriormente.
function beginSearchAddressBatch(requests: SearchAddressRequest[], options?: SearchAddressBatchOptions): Promise<FuzzySearchBatchPoller>Parâmetros
- requests
A matriz de solicitações de pesquisa a serem processadas. A matriz pode conter um máximo de 10.000 solicitações e deve conter pelo menos 1 solicitação.
- options
- SearchAddressBatchOptions
Parâmetros opcionais para a operação
Retornos
Promise<FuzzySearchBatchPoller>
fuzzySearch(SearchQuery, FuzzySearchBaseOptions & OperationOptions)
Executa uma pesquisa de forma livre que lida com as entradas mais difusas, lidando com qualquer combinação de endereços ou tokens de POI.
function fuzzySearch(searchQuery: SearchQuery, options?: FuzzySearchBaseOptions & OperationOptions): Promise<SearchAddressResult>Parâmetros
- searchQuery
- SearchQuery
Consulta de texto e informações de localização a serem pesquisadas
- options
Opções para pesquisa difusa
Retornos
Promise<SearchAddressResult>
getGeometries(string[], OperationOptions)
Solicita os dados de geometria, como um contorno de cidade ou país para um conjunto de entidades.
function getGeometries(geometryIds: string[], options?: OperationOptions): Promise<EntityGeometry[]>Parâmetros
- geometryIds
-
string[]
Lista separada por vírgulas de UUIDs de geometria, recuperada anteriormente de uma solicitação de Pesquisa Online.
- options
- OperationOptions
Parâmetros opcionais para a operação
Retornos
Promise<EntityGeometry[]>
getPointOfInterestCategories(GetPointOfInterestCategoriesOptions)
Solicita uma lista completa das categorias de Pontos de Interesse (POI) suportadas.
function getPointOfInterestCategories(options?: GetPointOfInterestCategoriesOptions): Promise<PointOfInterestCategory[]>Parâmetros
Parâmetros opcionais para a operação
Retornos
Promise<PointOfInterestCategory[]>
resumeFuzzySearchBatch(string, FuzzySearchBatchOptions)
Continue a solicitação de pesquisa difusa com um estado serializado de outro poller.
Exemplo
const serializedState = poller.toString()
const rehydratedPoller = resumeFuzzySearchBatch(serializedState)
rehydratedPoller.poll()
function resumeFuzzySearchBatch(restoreFrom: string, options?: FuzzySearchBatchOptions): Promise<FuzzySearchBatchPoller>Parâmetros
- restoreFrom
-
string
O estado serializado do pesquisador anterior.
- options
- FuzzySearchBatchOptions
Parâmetros opcionais para a operação.
Retornos
Promise<FuzzySearchBatchPoller>
resumeReverseSearchAddressBatch(string, ReverseSearchAddressBatchOptions)
Continue a solicitação de pesquisa de endereço inverso com um estado serializado de outro poller.
Exemplo
const serializedState = poller.toString()
const rehydratedPoller = resumeReverseSearchAddressBatch(serializedState)
rehydratedPoller.poll()
function resumeReverseSearchAddressBatch(restoreFrom: string, options?: ReverseSearchAddressBatchOptions): Promise<ReverseSearchAddressBatchPoller>Parâmetros
- restoreFrom
-
string
O estado serializado do pesquisador anterior.
- options
- ReverseSearchAddressBatchOptions
Parâmetros opcionais para a operação.
Retornos
Promise<ReverseSearchAddressBatchPoller>
resumeSearchAddressBatch(string, SearchAddressBatchOptions)
Continue a solicitação de pesquisa de endereço com um estado serializado de outro poller.
Exemplo
const serializedState = poller.toString()
const rehydratedPoller = resumeSearchAddressBatch(serializedState)
rehydratedPoller.poll()
function resumeSearchAddressBatch(restoreFrom: string, options?: SearchAddressBatchOptions): Promise<FuzzySearchBatchPoller>Parâmetros
- restoreFrom
-
string
O estado serializado do pesquisador anterior.
- options
- SearchAddressBatchOptions
Parâmetros opcionais para a operação.
Retornos
Promise<FuzzySearchBatchPoller>
reverseSearchAddress(LatLon, ReverseSearchAddressOptions & OperationOptions)
Traduz uma coordenada em um endereço compreensível para humanos.
function reverseSearchAddress(coordinates: LatLon, options?: ReverseSearchAddressOptions & OperationOptions): Promise<ReverseSearchAddressResult>Parâmetros
- coordinates
- LatLon
As coordenadas para a consulta de pesquisa reversa
- options
Parâmetros opcionais para a operação
Retornos
Promise<ReverseSearchAddressResult>
reverseSearchCrossStreetAddress(LatLon, ReverseSearchCrossStreetAddressOptions)
Traduz uma coordenada em uma rua transversal compreensível por humanos.
function reverseSearchCrossStreetAddress(coordinates: LatLon, options?: ReverseSearchCrossStreetAddressOptions): Promise<ReverseSearchCrossStreetAddressResult>Parâmetros
- coordinates
- LatLon
As coordenadas para a consulta de pesquisa reversa
Parâmetros opcionais para a operação
Retornos
searchAddress(string, SearchAddressOptions & OperationOptions)
Geocodifica um endereço.
function searchAddress(query: string, options?: SearchAddressOptions & OperationOptions): Promise<SearchAddressResult>Parâmetros
- query
-
string
O endereço a ser pesquisado (por exemplo, "1 Microsoft way, Redmond, WA")
- options
Parâmetros opcionais para a operação
Retornos
Promise<SearchAddressResult>
searchAlongRoute(string, number, GeoJsonLineString, SearchAlongRouteOptions)
Executa uma pesquisa difusa de POIs ao longo de uma rota especificada.
function searchAlongRoute(query: string, maxDetourTimeInSeconds: number, route: GeoJsonLineString, options?: SearchAlongRouteOptions): Promise<SearchAddressResult>Parâmetros
- query
-
string
O nome da POI a ser procurado (por exemplo, "estátua da liberdade", "starbucks", "pizza").
- maxDetourTimeInSeconds
-
number
Tempo máximo de desvio do ponto de interesse em segundos. O valor máximo é de 3600 segundos
- route
- GeoJsonLineString
Isso representa a rota a ser pesquisada e deve ser um tipo válido GeoJSON LineString .
- options
- SearchAlongRouteOptions
Parâmetros opcionais para a operação
Retornos
Promise<SearchAddressResult>
searchInsideGeometry(string, SearchGeometry, SearchInsideGeometryOptions)
Executa uma pesquisa de forma livre dentro de uma única geometria ou de muitas delas.
function searchInsideGeometry(query: string, geometry: SearchGeometry, options?: SearchInsideGeometryOptions): Promise<SearchAddressResult>Parâmetros
- query
-
string
O nome da POI a ser procurado (por exemplo, "estátua da liberdade", "starbucks", "pizza").
- geometry
- SearchGeometry
Isso representa a geometria de um ou mais recursos geográficos (parques, limite de estado etc.) para pesquisar e deve ser um tipo compatível com GeoJSON. Consulte RFC 7946 para obter detalhes.
- options
- SearchInsideGeometryOptions
Parâmetros opcionais para a operação
Retornos
Promise<SearchAddressResult>
searchNearbyPointOfInterest(LatLon, SearchNearbyPointOfInterestOptions)
Solicita resultados de pontos de interesse (POI) em torno de um local específico.
function searchNearbyPointOfInterest(coordinates: LatLon, options?: SearchNearbyPointOfInterestOptions): Promise<SearchAddressResult>Parâmetros
- coordinates
- LatLon
As coordenadas para a pesquisa de POI nas proximidades
Parâmetros opcionais para a operação
Retornos
Promise<SearchAddressResult>
searchPointOfInterest(SearchQuery, SearchPointOfInterestOptions)
Solicita resultados de pontos de interesse (POI) por nome
function searchPointOfInterest(searchQuery: SearchQuery, options?: SearchPointOfInterestOptions): Promise<SearchAddressResult>Parâmetros
- searchQuery
- SearchQuery
Consulta de texto e informações de localização a serem pesquisadas
- options
- SearchPointOfInterestOptions
Opções para pesquisar POI
Retornos
Promise<SearchAddressResult>
searchPointOfInterestCategory(SearchQuery, SearchPointOfInterestOptions)
Solicita resultados de pontos de interesse (POI) de determinada categoria.
function searchPointOfInterestCategory(searchQuery: SearchQuery, options?: SearchPointOfInterestOptions): Promise<SearchAddressResult>Parâmetros
- searchQuery
- SearchQuery
Consulta de texto e informações de localização a serem pesquisadas
- options
- SearchPointOfInterestOptions
Opções para pesquisar categoria de POI
Retornos
Promise<SearchAddressResult>
searchStructuredAddress(StructuredAddress, SearchStructuredAddressOptions)
Geocodifica um endereço estruturado.
function searchStructuredAddress(structuredAddress: StructuredAddress, options?: SearchStructuredAddressOptions): Promise<SearchAddressResult>Parâmetros
- structuredAddress
- StructuredAddress
Endereço estruturado usado para geocodificação
- options
- SearchStructuredAddressOptions
Parâmetros opcionais para a operação
Retornos
Promise<SearchAddressResult>
