Share via

SearchPointOfInterestOptions Class

  • Reference

Definition

Namespace:
Azure.Maps.Search
Assembly:
Azure.Maps.Search.dll
Package:
Azure.Maps.Search v1.0.0-beta.5
Source:
SearchPointOfInterestOptions.cs

Options.

public class SearchPointOfInterestOptions : Azure.Maps.Search.SearchAddressBaseOptions
type SearchPointOfInterestOptions = class
    inherit SearchAddressBaseOptions
Public Class SearchPointOfInterestOptions
Inherits SearchAddressBaseOptions
Inheritance
Object
SearchBaseOptions
SearchAddressBaseOptions
SearchPointOfInterestOptions
Derived

Constructors

SearchPointOfInterestOptions()

Properties

BrandFilter

A list of brand names which could be used to restrict the result to specific brands. Item order does not matter. When multiple brands are provided, only results that belong to (at least) one of the provided list will be returned. Brands that contain a "," in their name should be put into quotes.
CategoryFilter

A list of category set IDs which could be used to restrict the result to specific Points of Interest categories. ID order does not matter. When multiple category identifiers are provided, only POIs that belong to (at least) one of the categories from the provided list will be returned. The list of supported categories can be discovered using  POI Categories API.
Coordinates

A pair of coordinates (lon, lat) where results should be biased. E.g. -121.89, 37.337.

(Inherited from SearchAddressBaseOptions)
CountryFilter

Comma separated string of country codes, e.g. FR,ES. This will limit the search to the specified countries.

(Inherited from SearchAddressBaseOptions)
ElectricVehicleConnectorFilter

A list of connector types which could be used to restrict the result to Electric Vehicle Station supporting specific connector types. Item order does not matter. When multiple connector types are provided, only results that belong to (at least) one of the provided list will be returned. Please refer to ElectricVehicleConnector for all the available connector types
ExtendedPostalCodesFor

Indexes for which extended postal codes should be included in the results. Please refer to PointOfInterestExtendedPostalCodes for all the available extended postal codes
Language

Language in which search results should be returned. Should be one of supported IETF language tags, case insensitive. When data in specified language is not available for a specific field, default language is used. Please refer to Supported Languages for details.

(Inherited from SearchBaseOptions)
LocalizedMapView

The View parameter (also called the "user region" parameter) allows you to show the correct maps for a certain country/region for geopolitically disputed regions. Different countries have different views of such regions, and the View parameter allows your application to comply with the view required by the country your application will be serving. By default, the View parameter is set to “Unified” even if you haven’t defined it in the request. It is your responsibility to determine the location of your users, and then set the View parameter correctly for that location. Alternatively, you have the option to set ‘View=Auto’, which will return the map data based on the IP address of the request. The View parameter in Azure Maps must be used in compliance with applicable laws, including those regarding mapping, of the country where maps, images and other data and third party content that you are authorized to access via Azure Maps is made available. Example: view=IN.

Please refer to Supported Views for details and to see the available Views.

(Inherited from SearchBaseOptions)
RadiusInMeters

The radius in meters to for the results to be constrained to the defined area.

(Inherited from SearchAddressBaseOptions)
Skip

Starting offset of the returned results within the full result set. Default: 0, minimum: 0 and maximum: 1900.

(Inherited from SearchBaseOptions)
Top

Maximum number of responses that will be returned. Default: 10, minimum: 1 and maximum: 100.

(Inherited from SearchBaseOptions)

Applies to