Search

  • Information about the address of a location.

    Used in Place.address.

    Note that while OfflineSearchEngine.suggest and OfflineSearchEngine.suggestByText set all available details, SearchEngine.suggest and SearchEngine.suggestByText set only Address.addressText. Complete address details can be obtained by searching with PlaceIdQuery.

    See more

    Declaration

    Swift

    public struct Address : Hashable
  • Address type

    See more

    Declaration

    Swift

    public enum AddressType : UInt32, CaseIterable, Codable
  • The options to specify an address query. A AddressQuery.query can consist of parts of an address or full addresses, optionally comma separated. AddressQuery should 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, use TextQuery instead. SearchOptions.languageCode specifies the language of the AddressQuery.query and determines the preferred language of the results.

    See more

    Declaration

    Swift

    public struct AddressQuery : Hashable
  • Represents a type of area like country, state, city, county, etc.

    See more

    Declaration

    Swift

    public enum AreaType : UInt32, CaseIterable, Codable
  • Contains place details such as contacts, opening hours and some electro vehicle info.

    See more

    Declaration

    Swift

    public struct BusinessDetails : Hashable
  • The options to specify a query by categories.

    See more

    Declaration

    Swift

    public struct CategoryQuery : Hashable
  • Represents contact information.

    See more

    Declaration

    Swift

    public struct Contact : Hashable
  • Contains details of a specific place, such as contact information, opening hours and assigned categories.

    See more

    Declaration

    Swift

    public struct Details : Hashable
  • Represents data related to specific email address.

    See more

    Declaration

    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 more

    Declaration

    Swift

    public struct EMobilityServiceProvider : Hashable
  • Represents the restriction reason of an EVChargingPool.

    See more

    Declaration

    Swift

    public enum EVAccessRestrictionReason : UInt32, CaseIterable, Codable
  • Represents the accessibility level of an EVChargingPool.

    See more

    Declaration

    Swift

    public enum EVAccessType : UInt32, CaseIterable, Codable
  • Electric vehicle charging pool details.

    See more

    Declaration

    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 more

    Declaration

    Swift

    public struct Evse : Hashable
  • EVSE connector.

    See more

    Declaration

    Swift

    public struct EVSEConnector : Hashable
  • EVSE status

    See more

    Declaration

    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 more

    Declaration

    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 more

    Declaration

    Swift

    public enum FuelAdditiveType : UInt32, CaseIterable, Codable
  • Contains information about a specific fuel station.

    Use PlaceCategory.businessAndServicesPetrolGasolineStation to find fuel stations. In the Details of a Place result 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 more

    Declaration

    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 more

    Declaration

    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 more

    Declaration

    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 more

    Declaration

    Swift

    public struct GeoPlace : Hashable
  • Specifies members of Suggestion class to which input query can be matched.

    See more

    Declaration

    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 more

    Declaration

    Swift

    public class IndexRange
    extension IndexRange: NativeBase
    extension IndexRange: Hashable
  • Represents data related to specific landline phone number.

    See more

    Declaration

    Swift

    public struct LandlinePhone : Hashable
  • Contains geographical info about location

    See more

    Declaration

    Swift

    public struct LocationDetails : Hashable
  • Represents data related to specific mobile phone number.

    See more

    Declaration

    Swift

    public struct MobilePhone : Hashable
  • Represents opening hours information.

    See more

    Declaration

    Swift

    public struct OpeningHours : Hashable
  • Represents a location object, such as a country, a city, a point of interest (POI) etc.

    See more

    Declaration

    Swift

    public class Place
    extension Place: NativeBase
    extension Place: Hashable
  • Represents a category of place with different levels of granularity. This class also defines a set of most commonly used categories.

    See more

    Declaration

    Swift

    public class PlaceCategory
    extension PlaceCategory: NativeBase
    extension PlaceCategory: Hashable
  • Parameters related to HERE Places chain system.

    See more

    Declaration

    Swift

    public struct PlaceChain : Hashable
  • The filter options to specify a place. Consists of fuel, truck and EV options.

    See more

    Declaration

    Swift

    public struct PlaceFilter : Hashable
  • Parameters related to HERE Places cuisine system.

    See more

    Declaration

    Swift

    public struct PlaceFoodType : Hashable
  • The options to specify a Place id query.

    See more

    Declaration

    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?) -> Void

    Parameters

    searchError

    The search error.

    place

    The 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?) -> Void

    Parameters

    searchError

    The search error.

    place

    The place.

    responseDetails

    The response details.

  • Represents and error, which occurs during place serialization and deserialization routines.

    See more

    Declaration

    Swift

    public enum PlaceSerializationError : UInt32, CaseIterable, Codable
    extension PlaceSerializationError : Error
  • Place serialization exception

    Declaration

    Swift

    public typealias PlaceSerializationException = PlaceSerializationError
  • Specifies place type of Place result from a search query.

    See more

    Declaration

    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 more

    Declaration

    Swift

    public struct POIPaymentDetails : Hashable
  • Holds constants that represent payment methods.

    See POIPaymentDetails for 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 more

    Declaration

    Swift

    public struct POIPaymentMethod
  • Structure holding various information received with response to a query.

    See more

    Declaration

    Swift

    public struct ResponseDetails : Hashable
  • Encapsulates schedule details complying with the iCalendar specification: https://tools.ietf.org/html/rfc5545.

    See more

    Declaration

    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 nil at the same time - or not nil at the same time.

    Declaration

    Swift

    public typealias SearchCompletionHandler = (_ searchError: SearchError?, _ places: [Place]?) -> Void

    Parameters

    searchError

    An error enum indicating what went wrong. It is nil for an operation that succeeds.

    places

    The list of search results. It is nil in 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 nil at the same time - or not nil at the same time.

    Declaration

    Swift

    public typealias SearchExtendedCompletionHandler = (_ searchError: SearchError?, _ places: [Place]?, _ responseDetails: ResponseDetails?) -> Void

    Parameters

    searchError

    An error enum indicating what went wrong. It is nil for an operation that succeeds.

    places

    The list of search results. It is nil in case of an error.

    responseDetails

    Additional information provided with response. It is nil in 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 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 SearchCompletionHandler and the other uses a SearchExtendedCompletionHandler: 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.

    See more

    Declaration

    Swift

    public class SearchEngine : SearchInterface
    extension SearchEngine: NativeBase
    extension SearchEngine: Hashable
  • Specifies possible errors that may result from a search query.

    See more

    Declaration

    Swift

    public enum SearchError : UInt32, CaseIterable, Codable
  • Provides the protocol for the online and offline search engines.

    See more

    Declaration

    Swift

    public protocol SearchInterface : AnyObject
  • Encapsulates options that control the behavior of search and suggest operations.

    See more

    Declaration

    Swift

    public struct SearchOptions : Hashable
  • The options to specify a structured query. Only supported in OfflineSearchEngine (only available for the Navigate license).

    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 more

    Declaration

    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.place Query: SuggestionType.chain or SuggestionType.category

    With “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 more

    Declaration

    Swift

    public class Suggestion
    extension Suggestion: NativeBase
    extension Suggestion: Hashable
  • Specifies the type of suggestion returned for query.

    See more

    Declaration

    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 nil at the same time - or not nil at the same time.

    Declaration

    Swift

    public typealias SuggestCompletionHandler = (_ searchError: SearchError?, _ suggestions: [Suggestion]?) -> Void

    Parameters

    searchError

    An error enum indicating what went wrong. It is nil for an operation that succeeds.

    suggestions

    The list of suggestion results. It is nil in 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 nil at the same time - or not nil at the same time. This API is not supported by offline search.

    Declaration

    Swift

    public typealias SuggestExtendedCompletionHandler = (_ searchError: SearchError?, _ suggestions: [Suggestion]?, _ responseDetails: ResponseDetails?) -> Void

    Parameters

    searchError

    An error enum indicating what went wrong. It is nil for an operation that succeeds.

    suggestions

    The list of suggestion results. It is nil in case of an error.

    responseDetails

    Additional information provided with response. It is nil in case of an error.

  • Identifier of the place as provided by the supplier

    See more

    Declaration

    Swift

    public struct SupplierReference : Hashable
  • The options to specify a text query.

    See more

    Declaration

    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 more

    Declaration

    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 more

    Declaration

    Swift

    public struct TruckFuel : Hashable
  • Contains information about images, editorials, rating and a urls to them.

    See more

    Declaration

    Swift

    public struct WebDetails : Hashable
  • Contains information about editorial article and a link to it.

    See more

    Declaration

    Swift

    public struct WebEditorial : Hashable
  • Contains image information and direct link to it.

    See more

    Declaration

    Swift

    public struct WebImage : Hashable
  • Contains information about rating and a url to review.

    See more

    Declaration

    Swift

    public struct WebRating : Hashable
  • Represents data related to specific website address

    See more

    Declaration

    Swift

    public struct WebsiteAddress : Hashable
  • Contains information about provider of the item and a direct link to the item.

    See more

    Declaration

    Swift

    public struct WebSource : Hashable