Package version:

Class MapsSearchClient

Client class for interacting with Azure Maps Search Service.

Hierarchy

MapsSearchClient

Index

Constructors

Methods

beginFuzzySearchBatch beginReverseSearchAddressBatch beginSearchAddressBatch fuzzySearch getGeometries getPointOfInterestCategories resumeFuzzySearchBatch resumeReverseSearchAddressBatch resumeSearchAddressBatch reverseSearchAddress reverseSearchCrossStreetAddress searchAddress searchAlongRoute searchInsideGeometry searchNearbyPointOfInterest searchPointOfInterest searchPointOfInterestCategory searchStructuredAddress

Constructors

constructor

new MapsSearchClient(credential: AzureKeyCredential, options?: any): MapsSearchClient
Creates an instance of MapsSearchClient from a subscription key.

Example
```
import { MapsSearchClient, AzureKeyCredential } from "@azure/maps-search";

const credential = new AzureKeyCredential("<subscription-key>");
const client = new MapsSearchClient(credential);
```
Parameters
- credential: AzureKeyCredential
  
  An AzureKeyCredential instance used to authenticate requests to the service
- Optional options: any
  
  Options used to configure the Search Client
Returns MapsSearchClient
- Defined in mapsSearchClient.ts:183
new MapsSearchClient(credential: TokenCredential, mapsAccountClientId: string, options?: any): MapsSearchClient
Creates an instance of MapsSearchClient from an Azure Identity TokenCredential.

Example
```
import { MapsSearchClient } from "@azure/maps-search";
import { DefaultAzureCredential } from "@azure/identity";

const credential = new DefaultAzureCredential();
const client = new MapsSearchClient(credential, "<maps-account-client-id>");
```
Parameters
- credential: TokenCredential
  
  An TokenCredential instance used to authenticate requests to the service
- mapsAccountClientId: string
  
  The Azure Maps client id of a specific map resource
- Optional options: any
  
  Options used to configure the Search Client
Returns MapsSearchClient
- Defined in mapsSearchClient.ts:200

Methods

beginFuzzySearchBatch

beginFuzzySearchBatch(requests: Object, options?: any): Promise<SimplePollerLike<OperationState<BatchResult<SearchAddressResult>>, BatchResult<SearchAddressResult>>>
Sends batches of fuzzy search requests. The method returns a poller for retrieving the result later.
Parameters
- requests: Object
  
  The array of search requests to process. The array can contain a max of 10,000 requests and must contain at least 1 request.
- options: any = {}
  
  Optional parameters for the operation
Returns Promise<SimplePollerLike<OperationState<BatchResult<SearchAddressResult>>, BatchResult<SearchAddressResult>>>
- Defined in mapsSearchClient.ts:629

beginReverseSearchAddressBatch

beginReverseSearchAddressBatch(requests: Object, options?: any): Promise<SimplePollerLike<OperationState<BatchResult<ReverseSearchAddressResult>>, BatchResult<ReverseSearchAddressResult>>>
Sends batches of reverse geocoding requests. The method returns a poller for retrieving the result later.
Parameters
- requests: Object
  
  The array of search requests to process. The array can contain a max of 10,000 requests and must contain at least 1 request.
- options: any = {}
  
  Optional parameters for the operation
Returns Promise<SimplePollerLike<OperationState<BatchResult<ReverseSearchAddressResult>>, BatchResult<ReverseSearchAddressResult>>>
- Defined in mapsSearchClient.ts:789

beginSearchAddressBatch

beginSearchAddressBatch(requests: Object, options?: any): Promise<SimplePollerLike<OperationState<BatchResult<SearchAddressResult>>, BatchResult<SearchAddressResult>>>
Sends batches of geocoding requests. The method returns a poller for retrieving the result later.
Parameters
- requests: Object
  
  The array of search requests to process. The array can contain a max of 10,000 requests and must contain at least 1 request.
- options: any = {}
  
  Optional parameters for the operation
Returns Promise<SimplePollerLike<OperationState<BatchResult<SearchAddressResult>>, BatchResult<SearchAddressResult>>>
- Defined in mapsSearchClient.ts:709

fuzzySearch

fuzzySearch(searchQuery: SearchQuery, options?: any): Promise<SearchAddressResult>
Performs a free-form Search which handles the most fuzzy of inputs handling any combination of address or POI tokens.
Parameters
- searchQuery: SearchQuery
  
  Text query and location information to search
- options: any = {}
  
  Options for fuzzy search
Returns Promise<SearchAddressResult>
- Defined in mapsSearchClient.ts:285

getGeometries

getGeometries(geometryIds: Object, options?: OperationOptions): Promise<Object>
Requests the geometry data such as a city or country outline for a set of entities.
Parameters
- geometryIds: Object
  
  Comma separated list of geometry UUIDs, previously retrieved from an Online Search request.
- options: OperationOptions = {}
  
  Optional parameters for the operation
Returns Promise<Object>
- Defined in mapsSearchClient.ts:249

getPointOfInterestCategories

getPointOfInterestCategories(options?: GetPointOfInterestCategoriesOptions): Promise<Object>
Requests a full list of supported Points of Interest (POI) categories.
Parameters
- options: GetPointOfInterestCategoriesOptions = {}
  
  Optional parameters for the operation
Returns Promise<Object>
- Defined in mapsSearchClient.ts:425

resumeFuzzySearchBatch

resumeFuzzySearchBatch(restoreFrom: string, options?: any): Promise<SimplePollerLike<OperationState<BatchResult<SearchAddressResult>>, BatchResult<SearchAddressResult>>>
Continue the fuzzy search request with a serialized state from other poller.

Example
```
const serializedState = poller.toString()
const rehydratedPoller = resumeFuzzySearchBatch(serializedState)
rehydratedPoller.poll()
```
Parameters
- restoreFrom: string
  
  The serialized state from the previous poller.
- options: any = {}
  
  Optional parameters for the operation.
Returns Promise<SimplePollerLike<OperationState<BatchResult<SearchAddressResult>>, BatchResult<SearchAddressResult>>>
- Defined in mapsSearchClient.ts:650

resumeReverseSearchAddressBatch

resumeReverseSearchAddressBatch(restoreFrom: string, options?: any): Promise<SimplePollerLike<OperationState<BatchResult<ReverseSearchAddressResult>>, BatchResult<ReverseSearchAddressResult>>>
Continue the reverse address search request with a serialized state from other poller.

Example
```
const serializedState = poller.toString()
const rehydratedPoller = resumeReverseSearchAddressBatch(serializedState)
rehydratedPoller.poll()
```
Parameters
- restoreFrom: string
  
  The serialized state from the previous poller.
- options: any = {}
  
  Optional parameters for the operation.
Returns Promise<SimplePollerLike<OperationState<BatchResult<ReverseSearchAddressResult>>, BatchResult<ReverseSearchAddressResult>>>
- Defined in mapsSearchClient.ts:810

resumeSearchAddressBatch

resumeSearchAddressBatch(restoreFrom: string, options?: any): Promise<SimplePollerLike<OperationState<BatchResult<SearchAddressResult>>, BatchResult<SearchAddressResult>>>
Continue the address search request with a serialized state from other poller.

Example
```
const serializedState = poller.toString()
const rehydratedPoller = resumeSearchAddressBatch(serializedState)
rehydratedPoller.poll()
```
Parameters
- restoreFrom: string
  
  The serialized state from the previous poller.
- options: any = {}
  
  Optional parameters for the operation.
Returns Promise<SimplePollerLike<OperationState<BatchResult<SearchAddressResult>>, BatchResult<SearchAddressResult>>>
- Defined in mapsSearchClient.ts:730

reverseSearchAddress

reverseSearchAddress(coordinates: LatLon, options?: any): Promise<ReverseSearchAddressResult>
Translates a coordinates into a human understandable street address.
Parameters
- coordinates: LatLon
  
  The coordinates for the reverse search query
- options: any = {}
  
  Optional parameters for the operation
Returns Promise<ReverseSearchAddressResult>
- Defined in mapsSearchClient.ts:473

reverseSearchCrossStreetAddress

reverseSearchCrossStreetAddress(coordinates: LatLon, options?: ReverseSearchCrossStreetAddressOptions): Promise<ReverseSearchCrossStreetAddressResult>
Translates a coordinates into a human understandable cross street.
Parameters
- coordinates: LatLon
  
  The coordinates for the reverse search query
- options: ReverseSearchCrossStreetAddressOptions = {}
  
  Optional parameters for the operation
Returns Promise<ReverseSearchCrossStreetAddressResult>
- Defined in mapsSearchClient.ts:498

searchAddress

searchAddress(query: string, options?: any): Promise<SearchAddressResult>
Geocodes a address.
Parameters
- query: string
  
  The address to search for (e.g., "1 Microsoft way, Redmond, WA")
- options: any = {}
  
  Optional parameters for the operation
Returns Promise<SearchAddressResult>
- Defined in mapsSearchClient.ts:448

searchAlongRoute

searchAlongRoute(query: string, maxDetourTimeInSeconds: number, route: GeoJsonLineString, options?: SearchAlongRouteOptions): Promise<SearchAddressResult>
Performs a fuzzy search for POIs along a specified route.
Parameters
- query: string
  
  The POI name to search for (e.g., "statue of liberty", "starbucks", "pizza").
- maxDetourTimeInSeconds: number
  
  Maximum detour time of the point of interest in seconds. Max value is 3600 seconds
- route: GeoJsonLineString
  
  This represents the route to search along and should be a valid GeoJSON LineString type.
- options: SearchAlongRouteOptions = {}
  
  Optional parameters for the operation
Returns Promise<SearchAddressResult>
- Defined in mapsSearchClient.ts:599

searchInsideGeometry

searchInsideGeometry(query: string, geometry: any, options?: SearchInsideGeometryOptions): Promise<SearchAddressResult>
Performs a free form search inside a single geometry or many of them.
Parameters
- query: string
  
  The POI name to search for (e.g., "statue of liberty", "starbucks", "pizza").
- geometry: any
  
  This represents the geometry for one or more geographical features (parks, state boundary etc.) to search in and should be a GeoJSON compliant type. Please refer to RFC 7946 for details.
- options: SearchInsideGeometryOptions = {}
  
  Optional parameters for the operation
Returns Promise<SearchAddressResult>
- Defined in mapsSearchClient.ts:555

searchNearbyPointOfInterest

searchNearbyPointOfInterest(coordinates: LatLon, options?: SearchNearbyPointOfInterestOptions): Promise<SearchAddressResult>
Requests points of interest (POI) results around a specific location.
Parameters
- coordinates: LatLon
  
  The coordinates for the nearby POI search
- options: SearchNearbyPointOfInterestOptions = {}
  
  Optional parameters for the operation
Returns Promise<SearchAddressResult>
- Defined in mapsSearchClient.ts:362

searchPointOfInterest

searchPointOfInterest(searchQuery: SearchQuery, options?: any): Promise<SearchAddressResult>
Requests points of interest (POI) results by name
Parameters
- searchQuery: SearchQuery
  
  Text query and location information to search
- options: any = {}
  
  Options for search POI
Returns Promise<SearchAddressResult>
- Defined in mapsSearchClient.ts:323

searchPointOfInterestCategory

searchPointOfInterestCategory(searchQuery: SearchQuery, options?: any): Promise<SearchAddressResult>
Requests points of interests (POI) results from given category.
Parameters
- searchQuery: SearchQuery
  
  Text query and location information to search
- options: any = {}
  
  Options for search POI category
Returns Promise<SearchAddressResult>
- Defined in mapsSearchClient.ts:388

searchStructuredAddress

searchStructuredAddress(structuredAddress: StructuredAddress, options?: SearchStructuredAddressOptions): Promise<SearchAddressResult>
Geocodes a structured address.
Parameters
- structuredAddress: StructuredAddress
  
  Structured address used for geocoding
- options: SearchStructuredAddressOptions = {}
  
  Optional parameters for the operation
Returns Promise<SearchAddressResult>
- Defined in mapsSearchClient.ts:523

Class MapsSearchClient

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Example

Parameters

credential: AzureKeyCredential

Optional options: any

Returns MapsSearchClient

Example

Parameters

credential: TokenCredential

mapsAccountClientId: string

Optional options: any

Returns MapsSearchClient

Methods

beginFuzzySearchBatch

Parameters

requests: Object

options: any = {}

Returns Promise<SimplePollerLike<OperationState<BatchResult<SearchAddressResult>>, BatchResult<SearchAddressResult>>>

beginReverseSearchAddressBatch

Parameters

requests: Object

options: any = {}

Returns Promise<SimplePollerLike<OperationState<BatchResult<ReverseSearchAddressResult>>, BatchResult<ReverseSearchAddressResult>>>

beginSearchAddressBatch

Parameters

requests: Object

options: any = {}

Returns Promise<SimplePollerLike<OperationState<BatchResult<SearchAddressResult>>, BatchResult<SearchAddressResult>>>

fuzzySearch

Parameters

searchQuery: SearchQuery

options: any = {}

Returns Promise<SearchAddressResult>

getGeometries

Parameters

geometryIds: Object

options: OperationOptions = {}

Returns Promise<Object>

getPointOfInterestCategories

Parameters

options: GetPointOfInterestCategoriesOptions = {}

Returns Promise<Object>

resumeFuzzySearchBatch

Example

Parameters

restoreFrom: string

options: any = {}

Returns Promise<SimplePollerLike<OperationState<BatchResult<SearchAddressResult>>, BatchResult<SearchAddressResult>>>

resumeReverseSearchAddressBatch

Example

Parameters

restoreFrom: string

options: any = {}

Returns Promise<SimplePollerLike<OperationState<BatchResult<ReverseSearchAddressResult>>, BatchResult<ReverseSearchAddressResult>>>

resumeSearchAddressBatch

Example

Parameters

restoreFrom: string

options: any = {}

Returns Promise<SimplePollerLike<OperationState<BatchResult<SearchAddressResult>>, BatchResult<SearchAddressResult>>>

reverseSearchAddress

Parameters

coordinates: LatLon

options: any = {}

Returns Promise<ReverseSearchAddressResult>

reverseSearchCrossStreetAddress

Parameters

coordinates: LatLon

options: ReverseSearchCrossStreetAddressOptions = {}

Returns Promise<ReverseSearchCrossStreetAddressResult>

searchAddress

Parameters

query: string

options: any = {}

`Optional` options: any

`Optional` options: any