Package com.here.sdk.search

Class SearchOptions

java.lang.Object
com.here.sdk.search.SearchOptions
public final class SearchOptions extends Object

Encapsulates options that control the behavior of search and suggest operations.

  • Field Details

    • languageCode

      @Nullable public LanguageCode languageCode

      The preferred language of the result. When unset or unsupported language is chosen, results will be returned in their local language.

    • maxItems

      @Nullable public Integer maxItems

      The maximum number of items in the response. It should be in the range [1, 100]. When not set, results will be limited to 20. For location search (reverse geocode) by default results limited to 1.

    • highDensityEncodingEnabled

      public boolean highDensityEncodingEnabled

      Allows enabling high density encoding of relevant parameters. For now, it only affects input parameters of type GeoCorridor. Only supported for search in SearchEngine, otherwise it is ignored. Note: This is a closed-alpha release of this feature, so there could be a few bugs and unexpected behaviors. Related APIs may change for new releases without a deprecation process. Only participants of the closed-alpha group can get access from HERE to use this feature, otherwise, a SearchError.FORBIDDEN will be propagated in callbacks.

    • distributedResults

      public boolean distributedResults

      Indicates if search along the route should produce well-distributed results. It is only supported for:

  • Constructor Details

    • SearchOptions

      public SearchOptions()

      Creates an Options object. If no parameters are passed, uses default values (see fields description).

  • Method Details