Search Protocol Reference


                    
                    
                    search(options:completion:)

This method provides the capability to search places and POIs meeting various criteria.

Important

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

Declaration

Swift

func search(options: SearchOptions, completion: @escaping (Result<SearchResponse, Error>) -> ())

Parameters

`options`	The `SearchOptions` structure to limit the results.
`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.


                    
                    
                    autocomplete(options: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.

Important

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

Declaration

Swift

func autocomplete(options: AutocompleteOptions, completion: @escaping (Result<AutocompleteResponse, Error>) -> ())

Parameters

`options`	The `AutocompleteOptions` structure to limit the results.
`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.


                    
                    
                    requestPOICategories(options:completion:)

This method 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 POICategoryOptions.

Important

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

Declaration

Swift

func requestPOICategories(options: POICategoryOptions, completion: @escaping (Result<POICategoryResponse, Error>) -> ())

Parameters

`options`	The `POICategoryOptions` structure to limit the results.
`completion`	The completion closure is called after the response to the request has been processed. If no errors occurred, `POICategoryResponse` contains an array of categories and subcategories together with their translations and synonyms.


                    
                    
                    requestPOIDetails(options:completion:)

Provides detailed information about a POI based on its identifier (entityId).

Important

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

Declaration

Swift

func requestPOIDetails(
    options: POIDetailsOptions,
    completion: @escaping (Result<TomTomSDKSearch.POIDetailsResponse, Error>) -> ()
)

Parameters

`options`	Describes what POI Details data to request.
`completion`	The completion closure is called after the response to the request has been processed. If no errors occurred, `PoiDetailsResponse` contains the requested search result with POI info


                    
                    
                    requestGeometryData(options:completion:)

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

Important

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

Declaration

Swift

func requestGeometryData(options: GeometryDataOptions, completion: @escaping (Result<GeometryDataResponse, Error>) -> ())

Parameters

`options`	Define geometries to request.
`completion`	Parameter completion: The completion closure is called after the response to the request has been processed. If no errors occurred, `GeometryDataResponse` contains an array of geometries data structures