SearchAlongRouteOptions Class

Definition

Namespace:

Azure.Maps.Search

Assembly:

Azure.Maps.Search.dll

Package:

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

Source:

SearchAlongRouteOptions.cs

Options for Search Along Route API.

public class SearchAlongRouteOptions : Azure.Maps.Search.SearchGeometryBaseOptions

type SearchAlongRouteOptions = class
    inherit SearchGeometryBaseOptions

Public Class SearchAlongRouteOptions
Inherits SearchGeometryBaseOptions

Inheritance

Object

SearchGeometryBaseOptions

SearchAlongRouteOptions

Constructors

SearchAlongRouteOptions()

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. (Inherited from SearchGeometryBaseOptions)
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
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 SearchGeometryBaseOptions)
OperatingHours	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. Supported value: nextSevenDays (Inherited from SearchGeometryBaseOptions)
Top	Maximum number of responses that will be returned. Default: 10, minimum: 1 and maximum: 100. (Inherited from SearchGeometryBaseOptions)