Search
-
Information about the address of a location.
Used in
Place.address.Note that while
See moreOfflineSearchEngine.suggestandOfflineSearchEngine.suggestByTextset all available details,SearchEngine.suggestandSearchEngine.suggestByTextset onlyAddress.addressText. Complete address details can be obtained by searching withPlaceIdQuery.Declaration
Swift
public struct Address : Hashable -
Address type
See moreDeclaration
Swift
public enum AddressType : UInt32, CaseIterable, Codable -
The options to specify an address query. A
See moreAddressQuery.querycan consist of parts of an address or full addresses, optionally comma separated.AddressQueryshould only be used to search for parts of the address, excluding the POI name. For example, “Invalidenstraße 116, Berlin, Germany” is appropriate, whereas “HERE, Invalidenstraße 116, Berlin, Germany” is not. To be able to include the POI name, useTextQueryinstead.SearchOptions.languageCodespecifies the language of theAddressQuery.queryand determines the preferred language of the results.Declaration
Swift
public struct AddressQuery : Hashable -
Represents a type of area like country, state, city, county, etc.
See moreDeclaration
Swift
public enum AreaType : UInt32, CaseIterable, Codable -
Contains place details such as contacts, opening hours and some electro vehicle info.
See moreDeclaration
Swift
public struct BusinessDetails : Hashable -
The options to specify a query by categories.
See moreDeclaration
Swift
public struct CategoryQuery : Hashable -
Represents contact information.
See moreDeclaration
Swift
public struct Contact : Hashable -
Contains details of a specific place, such as contact information, opening hours and assigned categories.
See moreDeclaration
Swift
public struct Details : Hashable -
Represents data related to specific email address.
See moreDeclaration
Swift
public struct EmailAddress : Hashable -
eMSP (e-Mobility Service Provider) for which the EV station operator has EV roaming agreements. It is only available for online search.
See moreDeclaration
Swift
public struct EMobilityServiceProvider : Hashable -
Represents the restriction reason of an
See moreEVChargingPool.Declaration
Swift
public enum EVAccessRestrictionReason : UInt32, CaseIterable, Codable -
Represents the accessibility level of an
See moreEVChargingPool.Declaration
Swift
public enum EVAccessType : UInt32, CaseIterable, Codable -
Electric vehicle charging pool details.
See moreDeclaration
Swift
public struct EVChargingPoolDetails : Hashable -
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.
See moreDeclaration
Swift
public struct Evse : Hashable -
EVSE connector.
See moreDeclaration
Swift
public struct EVSEConnector : Hashable -
EVSE status
See moreDeclaration
Swift
public enum EVSEStatus : UInt32, CaseIterable, Codable -
Contains fuel additive information for generic fuel type.
Note: This is a beta 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.
See moreDeclaration
Swift
public struct FuelAdditive : Hashable -
Defines possible fuel additives that a fuel could contain.
Note: This is a beta 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.
See moreDeclaration
Swift
public enum FuelAdditiveType : UInt32, CaseIterable, Codable -
Contains information about a specific fuel station.
Use
PlaceCategory.businessAndServicesPetrolGasolineStationto find fuel stations. In theDetailsof aPlaceresult you can find the associated fuel station information, if any.Note: This is a beta 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.
See moreDeclaration
Swift
public struct FuelStation : Hashable -
Defines possible fuel types provided by a fuel station.
Note: This is a beta 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.
See moreDeclaration
Swift
public enum FuelType : UInt32, CaseIterable, Codable -
Contains generic fuel type info of fuel station.
Note: This is a beta 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.
See moreDeclaration
Swift
public struct GenericFuel : Hashable -
GeoPlace struct represents a location object: such as a country, a city, a point of interest (POI) etc. It can be used for PersonalPlace creation, in order to provide search on custom places.
See moreDeclaration
Swift
public struct GeoPlace : Hashable -
Specifies members of Suggestion class to which input query can be matched.
See moreDeclaration
Swift
public enum HighlightType : UInt32, CaseIterable, Codable -
Holds information to which part of the text, input query was matched. The first character is denoted by a value of 0.
See moreDeclaration
Swift
public class IndexRangeextension IndexRange: NativeBaseextension IndexRange: Hashable -
Represents data related to specific landline phone number.
See moreDeclaration
Swift
public struct LandlinePhone : Hashable -
Contains geographical info about location
See moreDeclaration
Swift
public struct LocationDetails : Hashable -
Represents data related to specific mobile phone number.
See moreDeclaration
Swift
public struct MobilePhone : Hashable -
Provides means to populate personal places data source. Also acts as a owner of the collection of personal places. MyPlaces is memory-only object: nothing is persisted and/or sent over the network. Client has full control on how to store personal places.
See moreDeclaration
Swift
public class MyPlacesextension MyPlaces: NativeBaseextension MyPlaces: Hashable -
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.
It provides the same interfaces as the SearchEngine, but the results may slightly differ as the results are taken from already downloaded map data instead of initiating a new request to a HERE backend service. This way the data may be, for example, older compared to the data you may receive when using the SearchEngine. On the other hand, this class provides results faster as no online connection is necessary.
In comparison to the SearchEngine, there are a few limitations:
- The IDs of POIs are different and may differ among different map versions.
- The implementation is different and the resources are limited, so the results can differ.
- OfflineSearchEngine sometimes doesn’t return the requested number of results.
Note: You can search only within persistent map data (downloaded via MapDownloader) or existing cached data. However, cached data may be incomplete, which can result in searches returning partial or incomplete information. Therefore, it is recommended to use persistent map data. Make sure that at least
See moreLayerConfiguration.Feature.offlineSearchis enabled. For EV rich attributes also enableLayerConfiguration.Feature.ev, for truck rich attributes also enableLayerConfiguration.Feature.truckServiceAttributes, for fuel station rich attributes also enableLayerConfiguration.Feature.fuelStationAttributesinSDKOptions.layerConfiguration.Declaration
Swift
public class OfflineSearchEngine : SearchInterfaceextension OfflineSearchEngine: NativeBaseextension OfflineSearchEngine: Hashable -
Note: This is a beta 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.
See moreDeclaration
Swift
public class OfflineSearchIndexextension OfflineSearchIndex: NativeBaseextension OfflineSearchIndex: Hashable -
Protocol to get updates about progress of creating persistent map index.
Note: This is a beta 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.
See moreDeclaration
Swift
public protocol OfflineSearchIndexListener : AnyObject -
Represents opening hours information.
See moreDeclaration
Swift
public struct OpeningHours : Hashable -
Represents a location object, such as a country, a city, a point of interest (POI) etc.
See moreDeclaration
Swift
public class Placeextension Place: NativeBaseextension Place: Hashable -
Represents a category of place with different levels of granularity. This class also defines a set of most commonly used categories.
See moreDeclaration
Swift
public class PlaceCategoryextension PlaceCategory: NativeBaseextension PlaceCategory: Hashable -
Parameters related to HERE Places chain system.
See moreDeclaration
Swift
public struct PlaceChain : Hashable -
The filter options to specify a place. Consists of fuel, truck and EV options.
See moreDeclaration
Swift
public struct PlaceFilter : Hashable -
Parameters related to HERE Places cuisine system.
See moreDeclaration
Swift
public struct PlaceFoodType : Hashable -
The options to specify a Place id query.
See moreDeclaration
Swift
public struct PlaceIdQuery : Hashable -
The method will be called on the main thread when a search by id call has been completed.
Declaration
Swift
public typealias PlaceIdSearchCompletionHandler = (_ searchError: SearchError?, _ place: Place?) -> VoidParameters
searchErrorThe search error.
placeThe place.
-
The method will be called on the main thread when a search by id call has been completed.
Declaration
Swift
public typealias PlaceIdSearchExtendedCompletionHandler = (_ searchError: SearchError?, _ place: Place?, _ responseDetails: ResponseDetails?) -> VoidParameters
searchErrorThe search error.
placeThe place.
responseDetailsThe response details.
-
Represents and error, which occurs during place serialization and deserialization routines.
See moreDeclaration
Swift
public enum PlaceSerializationError : UInt32, CaseIterable, Codableextension PlaceSerializationError : Error -
Place serialization exception
Declaration
Swift
public typealias PlaceSerializationException = PlaceSerializationError -
Specifies place type of Place result from a search query.
See moreDeclaration
Swift
public enum PlaceType : UInt32, CaseIterable, Codable -
Details about the payment options at the POI.
Note: This is a beta 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.
See moreDeclaration
Swift
public struct POIPaymentDetails : Hashable -
Holds constants that represent payment methods.
See
POIPaymentDetailsfor usage.Note: This is a beta 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.
See moreDeclaration
Swift
public struct POIPaymentMethod -
Structure holding various information received with response to a query.
See moreDeclaration
Swift
public struct ResponseDetails : Hashable -
Encapsulates schedule details complying with the iCalendar specification: https://tools.ietf.org/html/rfc5545.
See moreDeclaration
Swift
public struct ScheduleDetails : Hashable -
The method will be called on the main thread when a search call has been completed. The first argument indicates an error in case of a failure. The second argument contains the results. Both arguments cannot be
nilat the same time - or notnilat the same time.Declaration
Swift
public typealias SearchCompletionHandler = (_ searchError: SearchError?, _ places: [Place]?) -> VoidParameters
searchErrorAn error enum indicating what went wrong. It is
nilfor an operation that succeeds.placesThe list of search results. It is
nilin case of an error. -
The method will be called on the main thread when a search call has been completed. The first argument indicates an error in case of a failure. The second argument contains the results. Both arguments cannot be
nilat the same time - or notnilat the same time.Declaration
Swift
public typealias SearchExtendedCompletionHandler = (_ searchError: SearchError?, _ places: [Place]?, _ responseDetails: ResponseDetails?) -> VoidParameters
searchErrorAn error enum indicating what went wrong. It is
nilfor an operation that succeeds.placesThe list of search results. It is
nilin case of an error.responseDetailsAdditional information provided with response. It is
nilin case of an error. -
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
GeoPolylineset inside aGeoCorridoras part of aTextQuery.The SearchEngine API requires an online connection to execute the requests.
Note: All methods are provided in two flavors. One uses a
See moreSearchCompletionHandlerand the other uses aSearchExtendedCompletionHandler: The later adds aResponseDetailsresult type that provides therequestIdof a search request and acorrelationIdto identify multiple, related queries. This may be useful for debug purposes.Declaration
Swift
public class SearchEngine : SearchInterfaceextension SearchEngine: NativeBaseextension SearchEngine: Hashable -
Specifies possible errors that may result from a search query.
See moreDeclaration
Swift
public enum SearchError : UInt32, CaseIterable, Codable -
Provides the protocol for the online and offline search engines.
See moreDeclaration
Swift
public protocol SearchInterface : AnyObject -
Encapsulates options that control the behavior of search and suggest operations.
See moreDeclaration
Swift
public struct SearchOptions : Hashable -
The options to specify a structured query. Only supported in
OfflineSearchEngine(not available for all editions).Note: This is a beta 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.
See moreDeclaration
Swift
public struct StructuredQuery : Hashable -
Suggestion is meant to provide relevant suggestions to partial queries, like “restaur”, “starbu”, “eiffel”. Represents a relevant response to user queries. Suggestions (please check
SuggestionType) are either: Place:SuggestionType.placeQuery:SuggestionType.chainorSuggestionType.categoryWith “Place” you get data for a concrete place in the world. With “Query” something to follow-up, a way to perform more focused search.
See moreDeclaration
Swift
public class Suggestionextension Suggestion: NativeBaseextension Suggestion: Hashable -
Specifies the type of suggestion returned for query.
See moreDeclaration
Swift
public enum SuggestionType : UInt32, CaseIterable, Codable -
The method will be called on the main thread when a suggest call has been completed. The first argument indicates an error in case of a failure. The second argument contains the results. Both arguments cannot be
nilat the same time - or notnilat the same time.Declaration
Swift
public typealias SuggestCompletionHandler = (_ searchError: SearchError?, _ suggestions: [Suggestion]?) -> VoidParameters
searchErrorAn error enum indicating what went wrong. It is
nilfor an operation that succeeds.suggestionsThe list of suggestion results. It is
nilin case of an error. -
The method will be called on the main thread when a suggest call has been completed. The first argument indicates an error in case of a failure. The second argument contains the results. Both arguments cannot be
nilat the same time - or notnilat the same time. This API is not supported by offline search.Declaration
Swift
public typealias SuggestExtendedCompletionHandler = (_ searchError: SearchError?, _ suggestions: [Suggestion]?, _ responseDetails: ResponseDetails?) -> VoidParameters
searchErrorAn error enum indicating what went wrong. It is
nilfor an operation that succeeds.suggestionsThe list of suggestion results. It is
nilin case of an error.responseDetailsAdditional information provided with response. It is
nilin case of an error. -
Identifier of the place as provided by the supplier
See moreDeclaration
Swift
public struct SupplierReference : Hashable -
The options to specify a text query.
See moreDeclaration
Swift
public struct TextQuery : Hashable -
Truck amenities struct, represents availability (true/false) for each feature, except shower_count - number of showers, if data is available. Note: This is a BETA feature and thus subject to change.
See moreDeclaration
Swift
public struct TruckAmenities : Hashable -
Contains truck fuel type info of fuel station. Note: This is a BETA feature and thus subject to change.
See moreDeclaration
Swift
public struct TruckFuel : Hashable -
Contains information about images, editorials, rating and a urls to them.
See moreDeclaration
Swift
public struct WebDetails : Hashable -
Contains information about editorial article and a link to it.
See moreDeclaration
Swift
public struct WebEditorial : Hashable -
Contains image information and direct link to it.
See moreDeclaration
Swift
public struct WebImage : Hashable -
Contains information about rating and a url to review.
See moreDeclaration
Swift
public struct WebRating : Hashable -
Represents data related to specific website address
See moreDeclaration
Swift
public struct WebsiteAddress : Hashable -
Contains information about provider of the item and a direct link to the item.
See moreDeclaration
Swift
public struct WebSource : Hashable -
what3words is an alternative geocode system designed to identify any location on the planet. The system divides the world into a grid of 57 trillion 3-by-3-metre squares, each of which has a three-word address. For example, the front door of HERE’s Berlin office is identified by “///wage.mere.heap”.
W3WSearchEngineallows you to convert 3 word addresses to coordinates and also coordinates to 3 word addresses.Note: Using W3WSearchEngine requires a licence to access HERE what3words APIs.
Note: This is a beta 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.
See moreDeclaration
Swift
public class W3WSearchEngineextension W3WSearchEngine: NativeBaseextension W3WSearchEngine: Hashable -
Specifies possible errors that may result from a w3w search query.
See moreDeclaration
Swift
public enum W3WSearchError : UInt32, CaseIterable, Codable -
Contains information about one of the squares in the what3words geocode system.
Note: This is a beta 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.
See moreDeclaration
Swift
public struct W3WSquare : Hashable -
The method that will be called on the main thread when a search operation in
W3WSearchEnginehas been completed.Declaration
Swift
public typealias W3WSearchCompletionHandler = (_ searchError: W3WSearchError?, _ square: W3WSquare?) -> VoidParameters
searchErrorThe w3w search error.
squareThe w3w square.
Search Reference