Package com.here.android.mpa.search

The search package provides classes for performing places and geocoder searches.

See: Description

Interface Summary

Interface	Description
ResultListener<T>	Represents an event listener that reports information about the completion of a request.

Class Summary

Class	Description
Address	Provides textual address information for a Location.
AutoSuggest	Represents the base class for suggested places and searches.
AutoSuggestPlace	Represents an AutoSuggestPlace which contains information about a suggested Place.
AutoSuggestQuery	Represents an AutoSuggest with suggested completion of the given string
AutoSuggestSearch	Represents an AutoSuggestSearch which contains information about a refined search link.
Category	Represents a category with which a Place can be associated.
CategoryFilter	Represents a filter used when performing a search for popular places within a specific geographic area.
ContactDetail	Represents detailed information about a contact for a Place.
CreateLink	Represents a CreateLink which contains information to POST media content (image, review).
DiscoveryLink	Represents a discovery-related API link, used to retrieve a DiscoveryResultPage.
DiscoveryRequest	Represents an extended Request used to retrieve a DiscoveryResultPage object by way of Places search services.
DiscoveryResult	Represents a base class for a DiscoveryResult found in a DiscoveryResultPage.
DiscoveryResultPage	Represents a paginated collection of results from a request.
EditorialMedia	Represents editorial content about a Place.
ExploreRequest	Creates a ExploreRequest using a specified location context and category filter.
ExtendedAttribute	Represents additional detailed information about a Place.
GeocodeRequest	Deprecated As of release 3.6.
GeocodeRequest2	GeocodeRequest2 represents an extended Request used to retrieve Location data by way of Geocoder search services.
GeocodeResult	Represents the result of a geocode request.
HereRequest	The HereRequest answers the questions "Where am I?" and "What's right here where I am standing?" The search results consist of a list of places with addresses that lie within the vicinity of the search location.
ImageMedia	Represents image content related to a Place.
Link	Represents a Link indicating that the application must make another request to retrieve the desired resource.
Location	Represents the physical location of a Place.
Media	Represents the base class for additional rich content about a Place.
MediaCollectionPage<T>	Represents a base class for a paginateable collection of Media objects of a specific type.
MediaCollectionPageRequest<T>	Represents an extended Request used to retrieve MediaCollectionPage information for a specific type of Media associated with a Place, by way of Places search services.
Place	Represents a set of data about a physical place.
PlaceLink	Represents discovery information about a Place.
PlaceRequest	Represents an extended Request used to retrieve a Place object by way of Places search services.
RatingMedia	Represents rating content about a Place.
Ratings	Represents a summary of user-supplied ratings for a Place.
ReportingLink	Represents a ReportingLink for getting options for reporting on content if it contains inappropriate content.
Request<T>	Represents a base class for a search request.
ReverseGeocodeRequest	The ReverseGeocodeRequest represents an extended Request used to retrieve Address data by way of Geocoder search services.
ReviewMedia	Represents review content about a Place.
SearchRequest	The SearchRequest processes text string queries based on the user's input to find specific places.
SupplierLink	Represents a SupplierLink which contains meta-information about a supplier.
TextAutoSuggestionRequest	Represents an extended Request used to retrieve a List of search terms by way of Places search services.
UserLink	Represents a UserLink which contains additional attributes to describe a user.
ViaLink	Represents a ViaLink to an external website of the supplier of content.

Enum Summary

Enum	Description
AutoSuggest.Type	Represents values describing supported AutoSuggest types for a text suggestion.
Category.Global	Represents a set of fixed category filters on the resources of the Places search service.
DiscoveryResult.ResultType	Represents values describing possible DiscoveryResult types.
ErrorCode	Represents values describing possible search request errors.
Media.Type	Represents values describing supported Media types for a Place.
RichTextFormatting	Represents values describing possible formats for rich text content.
TextAutoSuggestionRequest.AutoSuggestFilterType	Represents values describing AutoSuggest response's result filter types that can be used to filter the AutoSuggest response.

Package com.here.android.mpa.search Description

The search package provides classes for performing places and geocoder searches.

To use the HERE Places feature, your application must include the google-gson library (release 2.2.4 or a compatible version) on its class path. This library can be downloaded from the google-gson project website at https://github.com/google/gson . Attempting to use the Places feature without adding this library causes runtime errors

• com.here.android.mpa.search.RequestCreator.Places provides methods to create new requests to search and explore places near a given position.
• com.here.android.mpa.search.RequestCreator.Geocoder provides methods to create new requests to perform address and reverse geocode searches.

The typical steps when perform a search are:

• Implement the ResultListener interface to handle the completion of the search
• Create a request using RequestCreator.Places or RequestCreator.Geocoder
• Start the search by invoking execute(ResultListener)
• When the search completes, the data returned in the ResultListener.onCompleted() callback is triggered

For more details on performing searches, please consult the "Places" section in the HERE SDK for Android Developer's Guide.