SearchEngine class abstract

The SearchEngine API unlocks the search, geocoding and suggesting capabilities of HERE services to provide developers with unmatched flexibility to create differentiating location-enabled applications.

It enables to search for HERE points of interests, forward and reverse geocode addresses and geographic coordinates from the HERE map and search for suggested addresses or place candidates based on incomplete or misspelled queries.

It also allows to search along a given GeoPolyline set inside a GeoCorridor as part of a TextQuery.

The SearchEngine API requires an online connection to execute the requests.

Note: All methods are provided in two flavors. One uses a SearchCallback and the other uses a SearchCallbackExtended: The later adds a ResponseDetails result type that provides the requestId of a search request and a correlationId to identify multiple, related queries. This may be useful for debug purposes.

Implemented types

Constructors

SearchEngine()
Creates a new instance of this class.
factory
SearchEngine.withSdkEngine(SDKNativeEngine sdkEngine)
Creates a new instance of this class.
factory

Properties

hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
searchByAddress(AddressQuery query, SearchOptions options, SearchCallback callback) → TaskHandle
Performs an asynchronous address query search for Place instances.
inherited
searchByAddressExtended(AddressQuery query, SearchOptions options, SearchCallbackExtended callback) → TaskHandle
Performs an asynchronous request to search for places based on a given address.
searchByCategory(CategoryQuery query, SearchOptions options, SearchCallback callback) → TaskHandle
Performs an asynchronous category search for Place instances.
inherited
searchByCategoryExtended(CategoryQuery query, SearchOptions options, SearchCallbackExtended callback) → TaskHandle
Performs an asynchronous request to do a category search for Place instances.
searchByCoordinates(GeoCoordinates coordinates, SearchOptions options, SearchCallback callback) → TaskHandle
Performs an asynchronous search for Place instances based on the given geographic coordinates.
inherited
searchByCoordinatesExtended(GeoCoordinates coordinates, SearchOptions options, SearchCallbackExtended callback) → TaskHandle
Performs an asynchronous request to search for places based on given geographic coordinates.
searchByCoordinatesWithRadius(GeoCircle circle, SearchOptions options, SearchCallback callback) → TaskHandle
Performs an asynchronous request to search for places based on given circular spatial filter.
searchByCoordinatesWithRadiusExtended(GeoCircle circle, SearchOptions options, SearchCallbackExtended callback) → TaskHandle
Performs an asynchronous request to search for places based on given circular spatial filter.
searchByPickedPlace(PickedPlace pickedPlace, LanguageCode? languageCode, PlaceIdSearchCallback callback) → TaskHandle
Performs an asynchronous search for a Place based on the content found in PickedPlace.
inherited
searchByPlaceId(PlaceIdQuery query, LanguageCode? languageCode, PlaceIdSearchCallback callback) → TaskHandle
Performs an asynchronous search for a Place based on its ID and LanguageCode.
inherited
searchByPlaceIdWithLanguageCodeExtended(PlaceIdQuery query, LanguageCode? languageCode, PlaceIdSearchCallbackExtended callback) → TaskHandle
Performs an asynchronous request to search for a Place based on its ID and LanguageCode.
searchByText(TextQuery query, SearchOptions options, SearchCallback callback) → TaskHandle
Performs an asynchronous text query search for Place instances within a given TextQueryArea.
inherited
searchByTextExtended(TextQuery query, SearchOptions options, SearchCallbackExtended callback) → TaskHandle
Performs an asynchronous request to do a text query search for Place instances.
sendRequest(String href, SearchCallback callback) → TaskHandle
Performs an asynchronous request by using the given href.
sendRequestExtended(String href, SearchCallbackExtended callback) → TaskHandle
Performs an asynchronous request by using the given href.
setCustomOption(String name, String value) → SearchError?
Sets a custom option for search backend queries.
suggestByText(TextQuery query, SearchOptions options, SuggestCallback callback) → TaskHandle
Performs an asynchronous request to suggest places for text queries and returns suggestions sorted by relevance.
inherited
suggestExtended(TextQuery query, SearchOptions options, SuggestCallbackExtended callback) → TaskHandle
Performs an asynchronous request to suggest places for text queries and returns candidate suggestions sorted by relevance.
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited