Package com.azure.maps.search.models

Class SearchPointOfInterestOptions

java.lang.Object
com.azure.maps.search.models.BaseSearchOptions<T>
com.azure.maps.search.models.BaseSearchPointOfInterestOptions<SearchPointOfInterestOptions>
com.azure.maps.search.models.SearchPointOfInterestOptions
public final class SearchPointOfInterestOptions extends BaseSearchPointOfInterestOptions<SearchPointOfInterestOptions>
Options for searching points of interest.

  • Constructor Details

    • SearchPointOfInterestOptions

      public SearchPointOfInterestOptions(String query)
      Builds fuzzy search options with query string and coordinates.
      Parameters:
      query - The query to be used to search for points of interest.

    • SearchPointOfInterestOptions

      public SearchPointOfInterestOptions(String query, com.azure.core.models.GeoPosition coordinates)
      Builds fuzzy search options with query string and coordinates.
      Parameters:
      query - The query to be used to search for points of interest.
      coordinates - The GeoPosition coordinates to be searched.

    • SearchPointOfInterestOptions

      public SearchPointOfInterestOptions(String query, List<String> countryFilter)
      Builds fuzzy search options with query string and country filter.
      Parameters:
      query - The query to be used to search for points of interest.
      countryFilter - A list of country codes - e.g. "US", "GB", "DE", etc.

  • Method Details

    • isTypeAhead

      public Boolean isTypeAhead()
      Returns whether this is a typeahead search.
      Returns:
      whether this is a typeahead search

    • getExtendedPostalCodesFor

      public List<PointOfInterestExtendedPostalCodes> getExtendedPostalCodesFor()
      Returns the extended postal codes for.
      Returns:
      the extended postal codes used for the search

    • getQuery

      public String getQuery()
      Returns the query string.
      Returns:
      the query string

    • isTypeAhead

      public SearchPointOfInterestOptions isTypeAhead(Boolean isTypeAhead)
      Sets whether this is a typeahead search.
      Parameters:
      isTypeAhead - whether this is a typeahead search.
      Returns:
      a reference to this SearchPointOfInterestOptions

    • setExtendedPostalCodesFor

      public SearchPointOfInterestOptions setExtendedPostalCodesFor(List<PointOfInterestExtendedPostalCodes> extendedPostalCodesFor)
      Sets the extended postal codes for.
      Parameters:
      extendedPostalCodesFor - extended postal codes used for search
      Returns:
      a reference to this SearchPointOfInterestOptions

    • setQuery

      public SearchPointOfInterestOptions setQuery(String query)
      Sets the query string.
      Parameters:
      query - the query string
      Returns:
      a reference to this SearchPointOfInterestOptions