Structures
The following structures are available globally.
-
Defines the parameters of the Autocomplete Search. Use
AutocompleteOptions
to make an Autocomplete Search request. To learn more about Autocomplete refer to theautocomplete(options:completion:)
description.You can also provide optional parameters to perform a more accurate search, following similar recommendation as for
search(options:completion:)
. An example of autocomplete searching for a restaurant in Amsterdam:
See morelet amsterdam = CLLocationCoordinate2D(latitude: 52.369979, longitude: 4.891820) let options = AutocompleteOptions( query: "Rest", position: amsterdam, radius: Measurement(value: 3, unit: .kilometers), countries: ["NL"], resultTypes: [.brand, .category], sessionID: UUID().uuidString )
Declaration
Swift
public struct AutocompleteOptions
-
Feedback event describing user interactions with the search results. The client application can report these events back to the search service to be used for analyzing and improving the search service.
Important
This is a Public Preview API. It may be changed or removed at any time.Declaration
Swift
public struct FeedbackEvent
-
Specifies the parameters of the geometries to query.
See moreDeclaration
Swift
public struct GeometryDataOptions
-
Defines fuel types supported in the fuzzy search.
See moreDeclaration
Swift
public struct FuelType : Hashable
extension FuelType: CustomDebugStringConvertible
-
Circle geometry for searchArea.
See moreDeclaration
Swift
public struct CircleGeometry : Equatable
-
Polygon geometry for searchArea.
See moreDeclaration
Swift
public struct PolygonGeometry : Equatable
-
Rectangle geometry for searchArea.
See moreDeclaration
Swift
public struct RectangleGeometry : Equatable
-
Specifies fuzzy search options.
See moreDeclaration
Swift
public struct SearchOptions
-
Represents a recognized autocomplete result defined by a
Brand
(e.g., “BMW” car brand).Use provided
Brand
in theSearchOptions.brands
to continue searching for places with the given brand.AutocompleteSegmentBrand
is part of theAutocompleteSegment
definition to describe brand-related information in the autocomplete search results.For example the query “BM” can return an autocomplete search result with the brand segment and the query “BMW”.
See moreDeclaration
Swift
public struct AutocompleteSegmentBrand
-
AutocompleteSegmentPOICategory
represents a point of interest (POI) category segment in the autocomplete search results.A POI category segment contains a
See morePOICategory
, which can be used as a filter in thesearch
method to refine search results based on the POI category information. It also includes an optionalmatchedAlternativeName
to provide an alternative name for the matched POI category, if available. This structure is used inAutocompleteSegment
to describe POI category-related information in the autocomplete search results.Declaration
Swift
public struct AutocompleteSegmentPOICategory
-
Represents the autocomplete result value that doesn’t match any brand or POI Category.
The
See moreplainText
can be used as a query string in theSearchOptions
to continue the search. It is used inAutocompleteSegment
to provide plain text-related information in the autocomplete search results. For example the query “Chess” can return an autocomplete search result with the plain text segment and the query “Chess”.Declaration
Swift
public struct AutocompleteSegmentPlainText
-
Defines the POI identifier (POIID) required to fetch POI details.
See moreDeclaration
Swift
public struct POIID
-
A structure enclosing related data IDs.
See moreDeclaration
Swift
public struct SearchResultID
-
A container for the identifier of charging availability.
See moreDeclaration
Swift
public struct EVChargingAvailabilityID
-
A container for parking detail identifier.
See moreDeclaration
Swift
public struct ParkingDetailID
-
A container for the fuel price identifier
See moreDeclaration
Swift
public struct FuelPriceID
-
SearchResult Object containing grouped information about places or points of interest.
See moreDeclaration
Swift
public struct SearchResult
-
Contains information about an EV charging park.
Important
This is a Public Preview API. It may be changed or removed at any time.Declaration
Swift
public struct ChargingPark
-
Defines the OpeningHours of a POI.
See moreDeclaration
Swift
public struct OpeningHours
-
Point of Interest information for a search result.
See moreDeclaration
Swift
public struct POI
-
POI category ID.
See moreDeclaration
Swift
public struct POICategoryID : Hashable
-
GeometryDataResponse
See moreDeclaration
Swift
public struct GeometryDataResponse
-
Structure containing POI category response.
See moreDeclaration
Swift
public struct POICategoryResponse
-
Structure containing POI category details.
See moreDeclaration
Swift
public struct POICategory
-
The result returned by
See moreSearch.requestPOIDetails(options:completion:)
.Declaration
Swift
public struct POIDetailsResponse
-
A response structure that contains search results for the requested search query
See moreDeclaration
Swift
public struct SearchResponse