OfflineSearch

public final class OfflineSearch : Search

The Offline Search API provides several types of search using an offline map.

Important

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

Lifecycle


                    
                    
                    init(store:)

OfflineSearch init method.

Important

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

Declaration

Swift

public init(store: MapDataStore) throws

Parameters

`store`	a `MapDataStore` providing access to the offline map.
`customPOIDataProviders`	Custom data providers for injecting external POI data into the search engine.

Public


                    
                    
                    search(options:completion:)

This API allows 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

public func search(
    options: SearchOptions,
    completion: @escaping (Result<TomTomSDKSearch.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.


                    
                    
                    requestPOICategories(options:completion:)

This API 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

public 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.


                    
                    
                    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

public func autocomplete(
    options: AutocompleteOptions,
    completion: @escaping (Result<TomTomSDKSearch.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.


                    
                    
                    requestPOIDetails(options:completion:)

This API provides detailed information about a place based on its identifier (entityId).

Important

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

Declaration

Swift

public 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 a search result associated with the requested POI.


                    
                    
                    requestGeometryData(options:completion:)

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

Note

This API is not supported for offline search so far.

Important

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

Declaration

Swift

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

Parameters

`options`	The structure that defines 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