MapsSearchClient.SearchPointOfInterest Method

Definition

Namespace:

Azure.Maps.Search

Assembly:

Azure.Maps.Search.dll

Package:

Azure.Maps.Search v1.0.0-beta.5

Source:

MapsSearchClient.cs

Points of Interest (POI) Search allows you to request POI results by name. Search supports additional query parameters such as language and filtering results by area of interest driven by country or bounding box. Endpoint will return only POI results matching the query string. Response includes POI details such as address, a pair of coordinates location and category.

public virtual Azure.Response<Azure.Maps.Search.Models.SearchAddressResult> SearchPointOfInterest (string query, bool? IsTypeAhead = default, Azure.Maps.Search.OperatingHoursRange? OperatingHours = default, Azure.Core.GeoJson.GeoBoundingBox BoundingBox = default, Azure.Maps.Search.SearchPointOfInterestOptions options = default, System.Threading.CancellationToken cancellationToken = default);

abstract member SearchPointOfInterest : string * Nullable<bool> * Nullable<Azure.Maps.Search.OperatingHoursRange> * Azure.Core.GeoJson.GeoBoundingBox * Azure.Maps.Search.SearchPointOfInterestOptions * System.Threading.CancellationToken -> Azure.Response<Azure.Maps.Search.Models.SearchAddressResult>
override this.SearchPointOfInterest : string * Nullable<bool> * Nullable<Azure.Maps.Search.OperatingHoursRange> * Azure.Core.GeoJson.GeoBoundingBox * Azure.Maps.Search.SearchPointOfInterestOptions * System.Threading.CancellationToken -> Azure.Response<Azure.Maps.Search.Models.SearchAddressResult>

Public Overridable Function SearchPointOfInterest (query As String, Optional IsTypeAhead As Nullable(Of Boolean) = Nothing, Optional OperatingHours As Nullable(Of OperatingHoursRange) = Nothing, Optional BoundingBox As GeoBoundingBox = Nothing, Optional options As SearchPointOfInterestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Response(Of SearchAddressResult)

Parameters

query

String

The POI name to search for (e.g., "statue of liberty", "starbucks"), must be properly URL encoded.

IsTypeAhead

Nullable<Boolean>

Boolean. If the typeahead flag is set, the query will be interpreted as a partial input and the search will enter predictive mode.

OperatingHours

Nullable<OperatingHoursRange>

Hours of operation for a POI (Points of Interest). The availability of hours of operation will vary based on the data available. If not passed, then no opening hours information will be returned.

BoundingBox

GeoBoundingBox

Bounding Box

options

SearchPointOfInterestOptions

additional options

cancellationToken

CancellationToken

The cancellation token to use.

Returns

Response<SearchAddressResult>