SearchService Protocol Reference


                    
                    
                    alongRoute(query:completion:)

This service allows you to perform a fuzzy search for POIs along a specified route.

Declaration

Swift

func alongRoute(query: AlongRouteQuery, completion: @escaping (SearchResponse?, Error?) -> ())

Parameters

`query`	The `AlongRouteQuery`. Query can be made using `AlongRouteQueryBuilder`.
`completion`	The completion closure is called after the response to the request has been processed. If no errors occurred, `SearchResponse` contains an array of search result and summary information.


                    
                    
                    fuzzySearch(query:completion:)

This service handles the most fuzzy of inputs containing any combination of Indexes abbreviation values. Additional search parameters like position, radius, openingHours, etc. can be taken into account using FuzzySearchQuery.

Declaration

Swift

func fuzzySearch(query: FuzzySearchQuery, completion: @escaping (SearchResponse?, Error?) -> ())

Parameters

`query`	The `FuzzySearchQuery`. Query can be made using `FuzzySearchQueryBuilder`.
`completion`	The completion closure is called after the response to the request has been processed. If no errors occurred, `SearchResponse` contains an array of search results and summary information.


                    
                    
                    geometrySearch(query:completion:)

The Geometry Search endpoint allows you to perform a free form search inside a single geometry or many of them.

Declaration

Swift

func geometrySearch(query: GeometrySearchQuery, completion: @escaping (SearchResponse?, Error?) -> ())

Parameters

`query`	The `GeometrySearchQuery`. Query can be made using `GeometrySearchQueryBuilder`.
`completion`	The completion closure is called after the response to the request has been processed. If no errors occurred, `SearchResponse` contains an array of search results and summary information.


                    
                    
                    poiCategories(query:completion:)

This service provides a full list of POI categories and subcategories together with their translations and synonyms. Additional POI category parameters like language can be taken into account using the POICategoriesQuery.

Declaration

Swift

func poiCategories(query: POICategoriesQuery, completion: @escaping (POICategoriesResponse?, Error?) -> ())

Parameters

`query`	The `POICategoriesQuery`. Query can be made using `POICategoriesQueryBuilder`.
`completion`	The completion closure is called after the response to the request has been processed. If no errors occurred, `POICategoriesResponse` contains an array of categories and subcategories together with their translations and synonyms.


                    
                    
                    autocomplete(query:completion:)

The Autocomplete API enables you to make a more meaningful Search API call by recognizing entities inside an input query and offering them as query terms.

Declaration

Swift

func autocomplete(query: AutocompleteQuery, completion: @escaping (AutocompleteResponse?, Error?) -> ())

Parameters

`query`	The `AutocompleteQuery`. That can be done using: `AutocompleteQueryBuilder`
`completion`	The completion closure is called after the response to the request has been processed. If no errors occurred, `AutocompleteResponse` contains proposed autocomplete elements, that can be used to implement an input field with the autocomplete feature.


                    
                    
                    placeByID(query:completion:)

The Place by ID service endpoint provides detailed information about a place based on its identifier (entityId).

Declaration

Swift

func placeByID(query: PlaceByIDQuery, completion: @escaping (SearchResponse?, Error?) -> ())

Parameters

`query`	The `PlaceByIDQuery`. That can be made using: `PlacebyIDQueryBuilder`.
`completion`	The completion closure is called after the response to the request has been processed. If no errors occurred, `SearchResponse` contains an array of categories and subcategories together with their translations and synonyms.


                    
                    
                    additionalData(query:completion:)

The Geometries Data Provider returns sets of coordinates that represent the outline of a city, country, or land area. The service supports batch requests of up to 20 identifiers.

Declaration

Swift

func additionalData(query: AdditionalDataQuery, completion: @escaping (AdditionalDataResponse?, Error?) -> ())


                    
                    
                    evChargingStationsAvailability(query:completion:)

The EV Charging Stations Availability endpoint provides information about the current availability of charging points, grouped by connector type and then power level. The response can be filtered by connector type and a range of charging powers, if provided (using optional request parameters).

Declaration

Swift

func evChargingStationsAvailability(
    query: EVChargingStationsAvailabilityQuery,
    completion: @escaping (EVChargingStationsAvailabilityResponse?, Error?) -> ()
)

Parameters

`query`	The `EVChargingStationsAvailabilityQuery`. Can be made using `EVChargingStationsAvailabilityQueryBuilder`.
`completion`	Parameter completion: The completion closure is called after the response to the request has been processed. If no errors occurred, `SearchResponse` contains an array of categories and subcategories together with their translations and synonyms.