SearchAddressOptions Class

Definition

Namespace:

Azure.Maps.Search

Assembly:

Azure.Maps.Search.dll

Package:

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

Source:

SearchAddressOptions.cs

Options for Search Address API.

public class SearchAddressOptions : Azure.Maps.Search.SearchAddressBaseOptions

type SearchAddressOptions = class
    inherit SearchAddressBaseOptions

Public Class SearchAddressOptions
Inherits SearchAddressBaseOptions

Inheritance

Object

SearchBaseOptions

SearchAddressBaseOptions

SearchAddressOptions

Constructors

SearchAddressOptions()

Properties

BoundingBox	bounding box.
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)
EntityType	Specifies the level of filtering performed on geographies. Narrows the search for specified geography entity types, e.g. return only municipality. The resulting response will contain the geography ID as well as the entity type matched. If you provide more than one entity as a comma separated list, endpoint will return the 'smallest entity available'. Returned Geometry ID can be used to get the geometry of that geography via Get Search Polygon API. The following parameters are ignored when entityType is set: heading number returnRoadUse returnSpeedLimit roadUse returnMatchType
ExtendedPostalCodesFor	Indexes for which extended postal codes should be included in the results. Available indexes are: Addr - Address ranges Geo - Geographies PAD - Point Addresses POI - Points of Interest Str - Streets XStr - Cross Streets (intersections) Value should be a comma separated list of index types (in any order) or null for no indexes. By default extended postal codes are included for all indexes except Geo. Extended postal code lists for geographies can be quite long so they have to be explicitly requested when needed.
IsTypeAhead	Boolean. If the typeahead flag is set, the query will be interpreted as a partial input and the search will enter predictive mode.
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)