Details
public struct Details : Hashable
Contains details of a specific place, such as contact information, opening hours and assigned categories.
-
The list of contact information of the place.
Note: Not available as part of
Suggestionresults.Declaration
Swift
public var contacts: [Contact] -
The list of opening hours information of the place.
Note: Not available as part of
Suggestionresults.Declaration
Swift
public var openingHours: [OpeningHours] -
The list of categories assigned to this place.
Declaration
Swift
public var categories: [PlaceCategory] -
The list of images associated with the place. The images are provided by external suppliers and are only available to users with valid contracts with said suppliers. If the user has no such contracts, the list is empty.
Note: Not available as part of
Suggestionresults.Declaration
Swift
public var images: [WebImage] -
The list of editorials associated with the place. The editorials are provided by external suppliers and are only available to users with valid contracts with said suppliers. If the user has no such contracts, the list is empty.
Note: Not available as part of
Suggestionresults.Declaration
Swift
public var editorials: [WebEditorial] -
The list of ratings associated with the place. The ratings are provided by external suppliers and are only available to users with valid contracts with said suppliers. If the user has no such contracts, the list is empty.
Note: Not available as part of
Suggestionresults.Declaration
Swift
public var ratings: [WebRating] -
The list of supplier references to this place. The references are provided by external suppliers and are only available to users with valid contracts with said suppliers. If the user has no such contracts, the list is empty.
Declaration
Swift
public var references: [SupplierReference] -
EV charging pool details. It is available only for a place that is a charging pool for electric vehicles. It is fully supported for offline search, provided that
LayerConfiguration.Feature.evis enabled inSDKOptions.layerConfiguration.For online search, this feature is only available if it is explicitly enabled. To do that, call
SearchEngine.set_custom_option()with arguments: name: “lookup.show” or “discover.show” or “browse.show” value: “ev” To enable this feature for all queries, callSearchEngine.set_custom_option()for all: “lookup.show”, “discover.show” and “browse.show”. To enable fuel station details or truck amenities, the custom option value can be combined as “ev,truck”, “ev,truck,fuel” etc.Declaration
Swift
public var evChargingPool: EVChargingPool? -
Additional information that is available only for places that contain truck amenities. It is fully supported for offline search, provided that
LayerConfiguration.Feature.truckServiceAttributesis enabled inSDKOptions.layerConfiguration.Note: Currently, for online search, this is a closed-alpha feature, so it is available only for selected customers. The field is always null for everyone that is not part of the closed-alpha group. Participants of the closed-alpha group can get access from HERE to use this feature. If the credentials are not enabled, a
SearchError.forbiddenwill be propagated.For online search, this feature is only available if it is explicitly enabled. To do that, call
SearchEngine.set_custom_option()with arguments: name: “lookup.show” or “discover.show” or “autosuggest.show” or “browse.show” value: “truck” To enable this feature for all queries, callSearchEngine.set_custom_option()for all: “lookup.show”, “discover.show”, “autosuggest.show” and “browse.show”. To enable bothtruck_amenitiesandfuel_stationfeatures, set the value to “fuel,truck”.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.
Declaration
Swift
public var truckAmenities: TruckAmenities? -
Fuel station details. It is available only if a place is a fuel station and contain fuel data. It is fully supported for offline search, provided that
LayerConfiguration.Feature.fuelStationAttributesis enabled inSDKOptions.layerConfiguration.Note: Currently, for online search, this is a closed-alpha feature, so it is available only for selected customers. The field is always null for everyone that is not part of the closed-alpha group. Participants of the closed-alpha group can get access from HERE to use this feature. If the credentials are not enabled, a
SearchError.forbiddenwill be propagated.For online search, this feature is only available if it is explicitly enabled. To do that, call
SearchEngine.set_custom_option()with arguments: name: “lookup.show” or “discover.show” or “autosuggest.show” or “browse.show” value: “fuel” To enable this feature for all queries, callSearchEngine.set_custom_option()for all: “lookup.show”, “discover.show”, “autosuggest.show” and “browse.show”. To enable bothtruck_amenitiesandfuel_stationfeatures, set the value to “fuel,truck”.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.
Declaration
Swift
public var fuelStation: FuelStation? -
The list of food types assigned to this place. Not supported in
OfflineSearchEngine(not available in all editions).Declaration
Swift
public var foodTypes: [PlaceFoodType] -
Details about the payment options at the POI. Set to
nilif the place is not a POI or if payment details are not available. Not supported inOfflineSearchEngine(not available in 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.
Declaration
Swift
public var payment: POIPaymentDetails? -
init(contacts:openingHours: categories: images: editorials: ratings: references: evChargingPool: truckAmenities: fuelStation: foodTypes: payment: ) Creates a new instance.
Parameters
- contacts: The list of contact information of the place.
Note: Not available as part of
Suggestionresults.- openingHours: The list of opening hours information of the place.
Note: Not available as part of
Suggestionresults.- categories: The list of categories assigned to this place.
- images: The list of images associated with the place. The images are provided by external suppliers and are only available to users with valid contracts with said suppliers. If the user has no such contracts, the list is empty.
Note: Not available as part of
Suggestionresults.- editorials: The list of editorials associated with the place. The editorials are provided by external suppliers and are only available to users with valid contracts with said suppliers. If the user has no such contracts, the list is empty.
Note: Not available as part of
Suggestionresults.- ratings: The list of ratings associated with the place. The ratings are provided by external suppliers and are only available to users with valid contracts with said suppliers. If the user has no such contracts, the list is empty.
Note: Not available as part of
Suggestionresults.- references: The list of supplier references to this place. The references are provided by external suppliers and are only available to users with valid contracts with said suppliers. If the user has no such contracts, the list is empty.
- evChargingPool: EV charging pool details. It is available only for a place that is a charging pool
for electric vehicles.
It is fully supported for offline search, provided that
LayerConfiguration.Feature.evis enabled inSDKOptions.layerConfiguration.
For online search, this feature is only available if it is explicitly enabled. To do that, call
SearchEngine.set_custom_option()with arguments: name: “lookup.show” or “discover.show” or “browse.show” value: “ev” To enable this feature for all queries, callSearchEngine.set_custom_option()for all: “lookup.show”, “discover.show” and “browse.show”. To enable fuel station details or truck amenities, the custom option value can be combined as “ev,truck”, “ev,truck,fuel” etc.- truckAmenities: Additional information that is available only for places that contain truck amenities.
It is fully supported for offline search, provided that
LayerConfiguration.Feature.truckServiceAttributesis enabled inSDKOptions.layerConfiguration.
Note: Currently, for online search, this is a closed-alpha feature, so it is available only for selected customers. The field is always null for everyone that is not part of the closed-alpha group. Participants of the closed-alpha group can get access from HERE to use this feature. If the credentials are not enabled, a
SearchError.forbiddenwill be propagated.For online search, this feature is only available if it is explicitly enabled. To do that, call
SearchEngine.set_custom_option()with arguments: name: “lookup.show” or “discover.show” or “autosuggest.show” or “browse.show” value: “truck” To enable this feature for all queries, callSearchEngine.set_custom_option()for all: “lookup.show”, “discover.show”, “autosuggest.show” and “browse.show”. To enable bothtruck_amenitiesandfuel_stationfeatures, set the value to “fuel,truck”.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.
- fuelStation: Fuel station details. It is available only if a place is a fuel station and contain fuel data.
It is fully supported for offline search, provided that
LayerConfiguration.Feature.fuelStationAttributesis enabled inSDKOptions.layerConfiguration.
Note: Currently, for online search, this is a closed-alpha feature, so it is available only for selected customers. The field is always null for everyone that is not part of the closed-alpha group. Participants of the closed-alpha group can get access from HERE to use this feature. If the credentials are not enabled, a
SearchError.forbiddenwill be propagated.For online search, this feature is only available if it is explicitly enabled. To do that, call
SearchEngine.set_custom_option()with arguments: name: “lookup.show” or “discover.show” or “autosuggest.show” or “browse.show” value: “fuel” To enable this feature for all queries, callSearchEngine.set_custom_option()for all: “lookup.show”, “discover.show”, “autosuggest.show” and “browse.show”. To enable bothtruck_amenitiesandfuel_stationfeatures, set the value to “fuel,truck”.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.
- foodTypes: The list of food types assigned to this place.
Not supported in
OfflineSearchEngine(not available in all editions). - payment: Details about the payment options at the POI.
Set to
nilif the place is not a POI or if payment details are not available. Not supported inOfflineSearchEngine(not available in 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.
Declaration
Swift
public init(contacts: [Contact], openingHours: [OpeningHours], categories: [PlaceCategory], images: [WebImage], editorials: [WebEditorial], ratings: [WebRating], references: [SupplierReference], evChargingPool: EVChargingPool? = nil, truckAmenities: TruckAmenities? = nil, fuelStation: FuelStation? = nil, foodTypes: [PlaceFoodType] = [], payment: POIPaymentDetails? = nil) -
Gets the list of primary categories assigned to this place.
Declaration
Swift
public func getPrimaryCategories() -> [PlaceCategory]Return Value
List of categories.