Structures

The following structures are available globally.

AutocompleteOptions

  • Defines the parameters of the Autocomplete Search. Use AutocompleteOptions to make an Autocomplete Search request. To learn more about Autocomplete refer to the autocomplete(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:

    let 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
     )
    
    See more

    Declaration

    Swift

    public struct AutocompleteOptions

FeedbackEvent

  • 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.
    See more

    Declaration

    Swift

    public struct FeedbackEvent
  • Specifies the parameters of the geometries to query.

    See more

    Declaration

    Swift

    public struct GeometryDataOptions

POICategoryOptions

  • Specifies the language and scope of POI categories.

    See more

    Declaration

    Swift

    public struct POICategoryOptions
  • Defines essential parameters to fetch POI details data.

    See more

    Declaration

    Swift

    public struct POIDetailsOptions

FuelType

  • Defines fuel types supported in the fuzzy search.

    See more

    Declaration

    Swift

    public struct FuelType : Hashable
    extension FuelType: CustomDebugStringConvertible

CircleGeometry

  • Circle geometry for searchArea.

    See more

    Declaration

    Swift

    public struct CircleGeometry : Equatable

PolygonGeometry

  • Polygon geometry for searchArea.

    See more

    Declaration

    Swift

    public struct PolygonGeometry : Equatable

RectangleGeometry

  • Rectangle geometry for searchArea.

    See more

    Declaration

    Swift

    public struct RectangleGeometry : Equatable

SearchOptions

AutocompleteSegmentBrand

  • Represents a recognized autocomplete result defined by a Brand (e.g., “BMW” car brand).

    Use provided Brand in the SearchOptions.brands to continue searching for places with the given brand. AutocompleteSegmentBrand is part of the AutocompleteSegment 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 more

    Declaration

    Swift

    public struct AutocompleteSegmentBrand

AutocompleteSegmentPOICategory

  • AutocompleteSegmentPOICategory represents a point of interest (POI) category segment in the autocomplete search results.

    A POI category segment contains a POICategory, which can be used as a filter in the search method to refine search results based on the POI category information. It also includes an optional matchedAlternativeName to provide an alternative name for the matched POI category, if available. This structure is used in AutocompleteSegment to describe POI category-related information in the autocomplete search results.

    See more

    Declaration

    Swift

    public struct AutocompleteSegmentPOICategory

AutocompleteSegmentPlainText

  • Represents the autocomplete result value that doesn’t match any brand or POI Category.

    The plainText can be used as a query string in the SearchOptions to continue the search. It is used in AutocompleteSegment 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”.

    See more

    Declaration

    Swift

    public struct AutocompleteSegmentPlainText

POIID

  • Defines the POI identifier (POIID) required to fetch POI details.

    See more

    Declaration

    Swift

    public struct POIID

SearchResultID

  • A structure enclosing related data IDs.

    See more

    Declaration

    Swift

    public struct SearchResultID

EVChargingAvailabilityID

ParkingDetailID

  • A container for parking detail identifier.

    See more

    Declaration

    Swift

    public struct ParkingDetailID

FuelPriceID

  • A container for the fuel price identifier

    See more

    Declaration

    Swift

    public struct FuelPriceID

SearchResult

  • SearchResult Object containing grouped information about places or points of interest.

    See more

    Declaration

    Swift

    public struct SearchResult

ChargingPark

  • Contains information about an EV charging park.

    Important

    This is a Public Preview API. It may be changed or removed at any time.
    See more

    Declaration

    Swift

    public struct ChargingPark

OpeningHours

  • Defines the OpeningHours of a POI.

    See more

    Declaration

    Swift

    public struct OpeningHours

POI

  • POI

    Point of Interest information for a search result.

    See more

    Declaration

    Swift

    public struct POI

Brand

  • Defines a POI brand.

    See more

    Declaration

    Swift

    public struct Brand : Hashable

POICategoryID

GeometryDataResponse

POICategoryResponse

POICategory

  • Structure containing POI category details.

    See more

    Declaration

    Swift

    public struct POICategory

POIDetailsResponse

SearchResponse

  • A response structure that contains search results for the requested search query

    See more

    Declaration

    Swift

    public struct SearchResponse