Represents one of the suggestions returned from the GeoStream server that matches the search term entered as part of a location search query.
Initializes a LocationSearchSuggestion object.
The bounding box of a region. This field will only be populated for region suggestions, where available; for other suggestions, this will return null.
The confidence in the suggestion. The confidence is a decimal number between 0 and 1, with 1 representing the highest confidence.
The country in which the suggestion is located.
A dictionary of custom data that can be used by custom search sources to provide additional data on suggestions beyond what is specified in other properties.
A concise one line summary of the suggestion for use when displaying it in a list of results. Contains information used to identify the suggestion in this context, such as name and address, excluding country.
A concise one line summary of the suggestion for use when displaying it in a list of results. Contains information used to identify the suggestion in this context, such as name and address, including country.
A LatLon representing the point where the address connects with the street network. This location is preferred over Location when reverse geocoding. May be set to 'Empty' if the suggestion has no single location.
The link ID of the StreetLink on which the suggestion is located. Set to 0 if the result is not associated with a link.
The LatLon object representing the suggestion's location.
The name of the search suggestion.
The PoiTypes of the suggestion. Applicable only when ResultType is a point of interest type. Defaults to an empty array.
The post or zip code for this suggestion.
The region level, which is used to create a list of region names in the appropriate order (from most specific to least specific).
The list of regions for this suggestion, with the most specific region (e.g. city) first.
The type of location search result. For example a street, region or post code.
The name of the street for the suggestion. Set to null if not a street suggestion.
The street number of the suggestion. This takes numbers only, unlike streetNumberFull.
The street number of the suggestion e.g. 20, 5b or 10-12. This takes characters aside from just numbers, unlike streetNumber.
The list of subregions for this suggestion (e.g. suburbs within a city).
The list of address units, such as an apartment or floor.
The vendor of the StreetLink on which the suggestion is located. Set to null when the result is not associated with a link.
Returns the street number of this suggestion as a string. If this suggestion doesn't have a valid street number, returns null instead.
the street number for the suggestion, or null if there is no street number
Generated using TypeDoc