search library

Classes

Address
Information about the address of a location.
AddressQuery
The options to specify an address query.
BusinessDetails
Contains place details such as contacts, opening hours and some electro vehicle info.
CategoryQuery
The options to specify a query by categories.
CategoryQueryArea
Area to perform search on.
Contact
Represents contact information.
DateRange
Represents the date range when the tariff element is valid.
Details
Contains details of a specific place, such as contact information, opening hours and assigned categories.
EmailAddress
Represents data related to specific email address.
EMobilityServiceProvider
eMSP (e-Mobility Service Provider) for which the EV station operator has EV roaming agreements.
EnergyMix
Represents details on the energy supplied at the charging location.
EnergySource
Energy source of EV charging point.
EnvironmentalImpact
Represents environmental impact for an environmental impact category.
EVChargingConnector
Represents a connector at the charging point.
EVChargingConnectorGroup
Represents the connector group at the charging location.
EVChargingConnectorReference
Represents a pairing of an EVSE and its connector(s) that belong to a group.
EVChargingDurationRange
Duration of the charging session when the tariff element is valid, in seconds.
EVChargingLocation
An electric vehicle (EV) charging location.
EVChargingOpeningHours
Represents the times when the EVSEs at the charging location can be accessed for charging.
EVChargingOpeningHoursException
Represents exceptions to the regular opening hours schedule for EV charging locations, such as special closures or extended hours.
EVChargingOpeningHoursSchedule
Opening hours schedule for EV charging locations, represented by a list of days of the week during which the location is open in the given time periods.
EVChargingOperator
Represents name and optionally other details about operator, suboperator, or e-Mobility service provider.
EVChargingPool
A charging pool for electric vehicles is an area equipped with one or more charging stations.
EVChargingPoolDetails
Electric vehicle charging pool details.
EVChargingStation
Group of connectors for electric vehicles (EVs), defined by a common charging connector type and maximum power level.
EVChargingTariff
Tariffs provide detailed pricing information for charging electric vehicles at a specific location.
EVChargingTariffElement
Represents a tariff element, which defines how pricing is applied.
EVChargingTariffElementCondition
Condition that the charging session needs to meet to apply the tariff element.
EVChargingTariffPriceComponent
Represents the price component of an EV charging tariff.
EVChargingTariffRequest
Represents a search option to choose the eMSP or CPO whose tariff should be included in the response.
EVChargingTruckRestriction
Represents access restrictions for trucks and light commercial vehicles.
Evse
Charge Point Operator (CPO) ID uses the Electric Vehicle Supply Equipment ID (EVSE ID) for an exact identification of the charging infrastructure and charging point.
EVSearchEngine
The EVSearchEngine API provides detailed information about charging locations.
EVSearchInterface
Provides the abstract class for the EVSearchEngine.
EVSearchOptions
Encapsulates additional options that control the behavior of EVSearchEngine.
EVSEConnector
EVSE connector.
EVSEInfo
Represents an EVSE at the charging point.
FuelAdditive
Contains fuel additive information for generic fuel type.
FuelStation
Contains information about a specific fuel station.
GenericFuel
Contains generic fuel type info of fuel station.
GeoPlace
GeoPlace struct represents a location object: such as a country, a city, a point of interest (POI) etc.
IndexRange
Holds information to which part of the text, input query was matched.
LandlinePhone
Represents data related to specific landline phone number.
LocationDetails
Contains geographical info about location
MobilePhone
Represents data related to specific mobile phone number.
MyPlaces
Provides means to populate personal places data source.
OfflineSearchEngine
The OfflineSearchEngine works without internet and unlocks the search and geocoding capabilities of HERE services to provide developers with unmatched flexibility to create differentiating location-enabled applications.
OfflineSearchIndex
Note: This is a beta release of this feature, so there could be a few bugs and unexpected behaviors.
OfflineSearchIndexListener
Abstract class to get updates about progress of creating persistent map index.
OfflineSearchIndexOptions
Options to set indexing for offline search.
OpeningHours
Represents opening hours information.
Place
Represents a location object, such as a country, a city, a point of interest (POI) etc.
PlaceCategory
Represents a category of place with different levels of granularity.
PlaceChain
Parameters related to HERE Places chain system.
PlaceFilter
The filter options to specify a place.
PlaceFilterEv
Constraints that are applicable on the places of category EV station.
PlaceFoodType
Parameters related to HERE Places cuisine system.
PlaceIdQuery
The options to specify a Place id query.
POIPaymentDetails
Details about the payment options at the POI.
POIPaymentMethod
Holds constants that represent payment methods.
ResponseDetails
Structure holding various information received with response to a query.
ScheduleDetails
Encapsulates schedule details complying with the iCalendar specification: https://tools.ietf.org/html/rfc5545.
SearchEngine
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.
SearchInterface
Provides the abstract class for the online and offline search engines.
SearchOptions
Encapsulates options that control the behavior of search and suggest operations.
StructuredQuery
The options to specify a structured query.
StructuredQueryAddressElements
Defines query address elements which will be used to build address hierarchy during searches.
Suggestion
Suggestion is meant to provide relevant suggestions to partial queries, like "restaur", "starbu", "eiffel".
SupplierReference
Identifier of the place as provided by the supplier
TextQuery
The options to specify a text query.
TextQueryArea
Area to perform search on.
TimeOfDayRange
Time period when the tariff element is valid, in local time.
TruckAmenities
Truck amenities struct, represents availability (true/false) for each feature, except shower_count - number of showers, if data is available.
TruckFuel
Contains truck fuel type info of fuel station.
W3WSearchEngine
what3words is an alternative geocode system designed to identify any location on the planet.
W3WSquare
Contains information about one of the squares in the what3words geocode system.
WebDetails
Contains information about images, editorials, rating and a urls to them.
WebEditorial
Contains information about editorial article and a link to it.
WebImage
Contains image information and direct link to it.
WebRating
Contains information about rating and a url to review.
WebsiteAddress
Represents data related to specific website address
WebSource
Contains information about provider of the item and a direct link to the item.

Enums

AddressType
Address type
AreaType
Represents a type of area like country, state, city, county, etc.
DayOfWeek
Represents the day of the week.
EnergySourceType
Represents energy source type.
EnvironmentalImpactCategory
Represents environmental impacts category of the environmental impact for energy mix.
EVAccessRestrictionReason
Represents the restriction reason of an EVChargingPool.
EVAccessType
Represents the accessibility level of an EVChargingPool.
EVChargingLocationFeature
Optional features that can be requested for EV charging locations.
EVChargingTariffDimension
Represents the dimension the price component, which determines what is being charged and how:
EVChargingTariffType
Represents the tariff pricing model (adhoc, emsp, or cpo).
EVChargingVehicleCategory
Represents the category of the vehicle supported at the charging point.
EVSearchError
Specifies possible errors that EVSearchEngine may report.
EVSEStatus
EVSE status
FacilityType
Represents facility type available at the location.
HighlightType
Specifies members of Suggestion class to which input query can be matched.
OfflineSearchIndexError
Error corresponding to the offline search operation.
OfflineSearchIndexOperation
Shows the operation that is performed over index.
ParkingType
Represents parking type available at the location.
PlaceSerializationError
Represents and error, which occurs during place serialization and deserialization routines.
PlaceType
Specifies place type of Place result from a search query.
SearchError
Specifies possible errors that may result from a search query.
StructuredQueryResultType
Specifies expected result type.
SuggestionType
Specifies the type of suggestion returned for query.
W3WSearchError
Specifies possible errors that may result from a w3w search query.

Typedefs

EVSearchCallback = void Function(EVSearchError? error, List<EVChargingLocation>? chargingLocations)
The method that will be called on the main thread when a search operation in EVSearchEngine has been completed.
PlaceIdSearchCallback = void Function(SearchError? searchError, Place? place)
The method will be called on the main thread when a search by id call has been completed.
PlaceIdSearchCallbackExtended = void Function(SearchError? searchError, Place? place, ResponseDetails? responseDetails)
The method will be called on the main thread when a search by id call has been completed.
SearchCallback = void Function(SearchError? searchError, List<Place>? places)
The method will be called on the main thread when a search call has been completed.
SearchCallbackExtended = void Function(SearchError? searchError, List<Place>? places, ResponseDetails? responseDetails)
The method will be called on the main thread when a search call has been completed.
SuggestCallback = void Function(SearchError? searchError, List<Suggestion>? suggestions)
The method will be called on the main thread when a suggest call has been completed.
SuggestCallbackExtended = void Function(SearchError? searchError, List<Suggestion>? suggestions, ResponseDetails? responseDetails)
The method will be called on the main thread when a suggest call has been completed.
W3WSearchCallback = void Function(W3WSearchError? searchError, W3WSquare? square)
The method that will be called on the main thread when a search operation in W3WSearchEngine has been completed.

Exceptions / Errors

PlaceSerializationExceptionException
Place serialization exception